summaryrefslogtreecommitdiff
path: root/doclet_adapter/src/main/java/com/google/doclava/javadoc/MethodDocImpl.java
blob: 50d2894762a927304010b04266c04a3dd963bfc6 (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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/*
 * 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.MethodDoc;
import com.sun.javadoc.Type;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.Modifier;
import javax.lang.model.element.TypeElement;
import javax.lang.model.type.TypeKind;
import javax.lang.model.type.TypeMirror;
import javax.lang.model.util.ElementFilter;
import javax.lang.model.util.Elements;
import javax.lang.model.util.Types;

class MethodDocImpl extends ExecutableMemberDocImpl implements MethodDoc {

    protected MethodDocImpl(ExecutableElement e, Context context) {
        super(e, context);
    }

    static MethodDocImpl create(ExecutableElement e, Context context) {
        return context.caches.methods.computeIfAbsent(e,
                el -> new MethodDocImpl(el, context));
    }

    @Override
    @Used(implemented = true)
    public String name() {
        return executableElement.getSimpleName().toString();
    }

    @Override
    @Used(implemented = true)
    public String qualifiedName() {
        var enclosingClass = executableElement.getEnclosingElement();
        return switch (enclosingClass.getKind()) {
            case CLASS, INTERFACE, ANNOTATION_TYPE, ENUM -> {
                var enclosingClassName =
                        ((TypeElement) enclosingClass).getQualifiedName().toString();
                yield enclosingClassName + "." + name();
            }
            default -> throw new UnsupportedOperationException("Expected CLASS, INTERFACE, "
                    + "ANNOTATION_TYPE or ENUM, but got " + enclosingClass.getKind());
        };
    }

    @Override
    @Unused(implemented = true)
    public boolean isMethod() {
        return true;
    }

    @Override
    @Used(implemented = true)
    public boolean isAbstract() {
        return java.lang.reflect.Modifier.isAbstract(reflectModifiers);
    }

    private Boolean isDefault;

    @Override
    @Used(implemented = true)
    public boolean isDefault() {
        if (isDefault == null) {
            isDefault = executableElement.getModifiers()
                    .stream()
                    .anyMatch(m -> m == Modifier.DEFAULT);
        }
        return isDefault;
    }

    @Override
    @Used(implemented = true)
    public Type returnType() {
        return TypeImpl.create(executableElement.getReturnType(), context);
    }

    @Override
    @Unused
    public ClassDoc overriddenClass() {
        throw new UnsupportedOperationException("not yet implemented");
    }

    @Override
    @Unused
    public Type overriddenType() {
        throw new UnsupportedOperationException("not yet implemented");
    }

    @Override
    @Used(implemented = true)
    public MethodDoc overriddenMethod() {
        if (isStatic()) {
            return null;
        }

        var enclosingElement = executableElement.getEnclosingElement();

        final Types typeUtils = context.environment.getTypeUtils();
        final Elements elemUtils = context.environment.getElementUtils();

        return switch (enclosingElement.getKind()) {
            case CLASS, INTERFACE, ANNOTATION_TYPE, ENUM -> {
                var owningClass = ((TypeElement) enclosingElement);
                for (TypeMirror superclass = owningClass.getSuperclass();
                        superclass.getKind() != TypeKind.NONE;
                        superclass = ((TypeElement) typeUtils.asElement(superclass)).getSuperclass()
                ) {
                    TypeElement superclassElem =
                            (TypeElement) typeUtils.asElement(superclass);
                    var overriden = ElementFilter.methodsIn(superclassElem.getEnclosedElements())
                            .stream()
                            .filter(exe -> elemUtils.overrides(executableElement, exe, owningClass))
                            .findFirst();
                    if (overriden.isPresent()) {
                        yield MethodDocImpl.create(overriden.get(), context);
                    }
                }
                yield null;
            }
            default -> throw new UnsupportedOperationException("Expected CLASS, INTERFACE, "
                    + "ANNOTATION_TYPE or ENUM, but got " + enclosingElement.getKind());
        };
    }

    @Override
    @Unused
    public boolean overrides(MethodDoc meth) {
        throw new UnsupportedOperationException("not yet implemented");
    }
}