Debian Codegraph @

checker/src/main/resources/javadoc.astub

raw
1 // This file, javadoc.astub, models the JavaDoc classes in the JDK's
2 // com.sun.javadoc package, which are not exposed by ct.sym and therefore
3 // cannot be part of an annotated JDK.
4 // It is annotated for the Value and Nullness checkers.
5
6 import org.checkerframework.common.value.qual.MinLen;
7
8 import org.checkerframework.checker.nullness.qual.Nullable;
9 import org.checkerframework.dataflow.qual.Pure;
10 import org.checkerframework.dataflow.qual.SideEffectFree;
11
12 package com.sun.javadoc;
13
14 public interface ClassDoc extends ProgramElementDoc, Type {
15 @Pure boolean isAbstract();
16 @Pure boolean isSerializable();
17 @Pure boolean isExternalizable();
18 MethodDoc[] serializationMethods();
19 FieldDoc[] serializableFields();
20 boolean definesSerializableFields();
21 ClassDoc superclass();
22 Type superclassType();
23 boolean subclassOf(ClassDoc cd);
24 ClassDoc[] interfaces();
25 Type[] interfaceTypes();
26 TypeVariable[] typeParameters();
27 ParamTag[] typeParamTags();
28 FieldDoc [] fields();
29 FieldDoc[] fields(boolean filter);
30 FieldDoc[] enumConstants();
31 MethodDoc[] methods();
32 MethodDoc[] methods(boolean filter);
33 ConstructorDoc[] constructors();
34 ConstructorDoc[] constructors(boolean filter);
35 ClassDoc[] innerClasses();
36 ClassDoc[] innerClasses(boolean filter);
37 ClassDoc findClass(String className);
38 @Deprecated ClassDoc[] importedClasses();
39 @Deprecated PackageDoc[] importedPackages();
40 }
41
42 public interface Doc extends java.lang.Comparable<java.lang.Object> {
43 public abstract java.lang.String commentText();
44 public abstract com.sun.javadoc.Tag [] tags();
45 public abstract com.sun.javadoc.Tag [] tags(java.lang.String a1);
46 public abstract com.sun.javadoc.SeeTag [] seeTags();
47 public abstract com.sun.javadoc.Tag [] inlineTags();
48 public abstract com.sun.javadoc.Tag [] firstSentenceTags();
49 public abstract java.lang.String getRawCommentText();
50 public abstract void setRawCommentText(java.lang.String a1);
51 public abstract java.lang.String name();
52 @Pure public abstract int compareTo(java.lang.Object a1);
53 @Pure public abstract boolean isField();
54 @Pure public abstract boolean isEnumConstant();
55 @Pure public abstract boolean isConstructor();
56 @Pure public abstract boolean isMethod();
57 @Pure public abstract boolean isAnnotationTypeElement();
58 @Pure public abstract boolean isInterface();
59 @Pure public abstract boolean isException();
60 @Pure public abstract boolean isError();
61 @Pure public abstract boolean isEnum();
62 @Pure public abstract boolean isAnnotationType();
63 @Pure public abstract boolean isOrdinaryClass();
64 @Pure public abstract boolean isClass();
65 @Pure public abstract boolean isIncluded();
66 public abstract com.sun.javadoc. @Nullable SourcePosition position();
67 }
68
69 public interface FieldDoc extends MemberDoc {
70 public abstract com.sun.javadoc.Type type();
71 @Pure public abstract boolean isTransient();
72 @Pure public abstract boolean isVolatile();
73 public abstract com.sun.javadoc.SerialFieldTag[] serialFieldTags();
74 public abstract @Nullable Object constantValue();
75 public abstract java.lang. @Nullable String constantValueExpression();
76 }
77
78 public interface MemberDoc extends ProgramElementDoc {
79 @Pure public abstract boolean isSynthetic();
80 }
81
82 public interface ProgramElementDoc extends Doc {
83 public abstract com.sun.javadoc. @Nullable ClassDoc containingClass();
84 public abstract com.sun.javadoc.PackageDoc containingPackage();
85 public abstract java.lang.String qualifiedName();
86 public abstract int modifierSpecifier();
87 public abstract java.lang.String modifiers();
88 public abstract com.sun.javadoc.AnnotationDesc[] annotations();
89 @Pure public abstract boolean isPublic();
90 @Pure public abstract boolean isProtected();
91 @Pure public abstract boolean isPrivate();
92 @Pure public abstract boolean isPackagePrivate();
93 @Pure public abstract boolean isStatic();
94 @Pure public abstract boolean isFinal();
95 }
96
97 public interface ExecutableMemberDoc extends MemberDoc {
98 ClassDoc[] thrownExceptions();
99 Type[] thrownExceptionTypes();
100 @Pure boolean isNative();
101 @Pure boolean isSynchronized();
102 @Pure public boolean isVarArgs();
103 Parameter[] parameters();
104 @Pure Type receiverType();
105 ThrowsTag[] throwsTags();
106 ParamTag[] paramTags();
107 ParamTag[] typeParamTags();
108 String signature();
109 String flatSignature();
110 TypeVariable[] typeParameters();
111 }
112
113 public interface RootDoc extends Doc, DocErrorReporter {
114 String [] @MinLen(1) [] options();
115 PackageDoc[] specifiedPackages();
116 ClassDoc[] specifiedClasses();
117 ClassDoc @MinLen(1) [] classes();
118 PackageDoc packageNamed(String name);
119 ClassDoc classNamed(String qualifiedName);
120 }
121
122 public interface SourcePosition {
123 @SideEffectFree File file();
124 @Pure int line();
125 @Pure int column();
126 @SideEffectFree String toString();
127 }