summaryrefslogtreecommitdiffstats
path: root/tools/droiddoc/src/MemberInfo.java
blob: 2a2572a4664f0b076b72e3acd381a75602a41e42 (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
/*
 * Copyright (C) 2008 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

public abstract class MemberInfo extends DocInfo implements Comparable, Scoped
{
    public MemberInfo(String rawCommentText, String name, String signature,
                        ClassInfo containingClass, ClassInfo realContainingClass,
                        boolean isPublic, boolean isProtected,
                        boolean isPackagePrivate, boolean isPrivate,
                        boolean isFinal, boolean isStatic, boolean isSynthetic,
                        String kind,
                        SourcePositionInfo position,
                        AnnotationInstanceInfo[] annotations)
    {
        super(rawCommentText, position);
        mName = name;
        mSignature = signature;
        mContainingClass = containingClass;
        mRealContainingClass = realContainingClass;
        mIsPublic = isPublic;
        mIsProtected = isProtected;
        mIsPackagePrivate = isPackagePrivate;
        mIsPrivate = isPrivate;
        mIsFinal = isFinal;
        mIsStatic = isStatic;
        mIsSynthetic = isSynthetic;
        mKind = kind;
        mAnnotations = annotations;
    }

    public abstract boolean isExecutable();

    public String anchor()
    {
        if (mSignature != null) {
            return mName + mSignature;
        } else {
            return mName;
        }
    }

    public String htmlPage() {
        return mContainingClass.htmlPage() + "#" + anchor();
    }

    public int compareTo(Object that) {
        return this.htmlPage().compareTo(((MemberInfo)that).htmlPage());
    }

    public String name()
    {
        return mName;
    }

    public String signature()
    {
        return mSignature;
    }

    public ClassInfo realContainingClass()
    {
        return mRealContainingClass;
    }

    public ClassInfo containingClass()
    {
        return mContainingClass;
    }

    public boolean isPublic()
    {
        return mIsPublic;
    }

    public boolean isProtected()
    {
        return mIsProtected;
    }

    public boolean isPackagePrivate()
    {
        return mIsPackagePrivate;
    }

    public boolean isPrivate()
    {
        return mIsPrivate;
    }

    public boolean isStatic()
    {
        return mIsStatic;
    }

    public boolean isFinal()
    {
        return mIsFinal;
    }

    public boolean isSynthetic()
    {
        return mIsSynthetic;
    }

    public ContainerInfo parent()
    {
        return mContainingClass;
    }

    public boolean checkLevel()
    {
        return DroidDoc.checkLevel(mIsPublic, mIsProtected,
                mIsPackagePrivate, mIsPrivate, isHidden());
    }

    public String kind()
    {
        return mKind;
    }
    
    public AnnotationInstanceInfo[] annotations()
    {
        return mAnnotations;
    }

    ClassInfo mContainingClass;
    ClassInfo mRealContainingClass;
    String mName;
    String mSignature;
    boolean mIsPublic;
    boolean mIsProtected;
    boolean mIsPackagePrivate;
    boolean mIsPrivate;
    boolean mIsFinal;
    boolean mIsStatic;
    boolean mIsSynthetic;
    String mKind;
    private AnnotationInstanceInfo[] mAnnotations;

}