summaryrefslogtreecommitdiff
path: root/doclava17/src/main/java/com/google/doclava/javadoc/SerialFieldTagImpl.java
blob: 1fbfa88f6d585c61e436d2919fbca8b32e3ed3f2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/*
 * Copyright (c) 2003, 2022, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.google.doclava.javadoc;

import com.google.doclava.annotation.Unused;
import com.google.doclava.annotation.Used;
import com.sun.javadoc.ClassDoc;
import com.sun.javadoc.SerialFieldTag;
import com.sun.source.doctree.SerialFieldTree;
import java.util.HashMap;
import javax.lang.model.element.Element;

class SerialFieldTagImpl extends TagImpl implements SerialFieldTag, Comparable<Object> {

    protected SerialFieldTagImpl(SerialFieldTree serialFieldTree, Element owner, Context context) {
        super(serialFieldTree, owner, context);
    }

    static SerialFieldTagImpl create(SerialFieldTree serialFieldTree, Element owner,
            Context context) {
        var tagsOfElement = context.caches.tags.serialField
                .computeIfAbsent(owner, el -> new HashMap<>());
        return tagsOfElement.computeIfAbsent(serialFieldTree,
                el -> new SerialFieldTagImpl(el, owner, context));
    }

    /**
     * Return the serialziable field name.
     */
    @Override
    @Unused
    public String fieldName() {
        throw new UnsupportedOperationException("not yet implemented");
    }

    /**
     * Return the field type string.
     */
    @Override
    public String fieldType() {
        throw new UnsupportedOperationException("not yet implemented");
    }

    /**
     * Return the ClassDocImpl for field type.
     *
     * @returns null if no ClassDocImpl for field type is visible from containingClass context.
     */
    @Override
    @Unused
    public ClassDoc fieldTypeDoc() {
        throw new UnsupportedOperationException("not yet implemented");
    }

    /**
     * Return the field comment. If there is no serialField comment, return javadoc comment of
     * corresponding FieldDocImpl.
     */
    @Override
    @Unused
    public String description() {
        throw new UnsupportedOperationException("not yet implemented");
    }

    /**
     * Return the kind of this tag.
     */
    @Override
    @Used(implemented = true)
    public String kind() {
        return "@serialField";
    }

    /**
     * Convert this object to a string.
     */
    @Unused
    public String toString() {
        throw new UnsupportedOperationException("not yet implemented");
    }

    /**
     * Compares this Object with the specified Object for order.  Returns a negative integer, zero,
     * or a positive integer as this Object is less than, equal to, or greater than the given
     * Object.
     * <p>
     * Included to make SerialFieldTagImpl items java.lang.Comparable.
     *
     * @param obj the <code>Object</code> to be compared.
     * @return a negative integer, zero, or a positive integer as this Object is less than, equal
     * to, or greater than the given Object.
     * @throws ClassCastException the specified Object's type prevents it from being compared to
     * this Object.
     * @since 1.2
     */
    @Override
    public int compareTo(Object obj) {
        throw new UnsupportedOperationException("not yet implemented");
    }
}