public class ClassInfo extends DocInfo implements ContainerInfo, Comparable, Scoped
Modifier and Type | Field and Description |
---|---|
static Comparator<ClassInfo> |
comparator |
static Comparator<ClassInfo> |
qualifiedComparator |
Constructor and Description |
---|
ClassInfo(com.sun.javadoc.ClassDoc cl,
String rawCommentText,
SourcePositionInfo position,
boolean isPublic,
boolean isProtected,
boolean isPackagePrivate,
boolean isPrivate,
boolean isStatic,
boolean isInterface,
boolean isAbstract,
boolean isOrdinaryClass,
boolean isException,
boolean isError,
boolean isEnum,
boolean isAnnotation,
boolean isFinal,
boolean isIncluded,
String name,
String qualifiedName,
String qualifiedTypeName,
boolean isPrimitive) |
ClassInfo(String qualifiedName)
Constructs a stub representation of a class.
|
Modifier and Type | Method and Description |
---|---|
void |
addConstructor(ConstructorInfo cInfo) |
void |
addField(FieldInfo fInfo) |
void |
addInterface(ClassInfo iface) |
void |
addMethod(MethodInfo method) |
MethodInfo[] |
allConstructors() |
Map<String,ConstructorInfo> |
allConstructorsMap() |
Map<String,FieldInfo> |
allFields() |
Map<String,MethodInfo> |
allMethods()
Returns all methods defined directly in this class.
|
FieldInfo[] |
allSelfFields() |
MethodInfo[] |
allSelfMethods() |
MethodInfo[] |
annotationElements() |
AnnotationInstanceInfo[] |
annotations() |
TypeInfo |
asTypeInfo() |
boolean |
checkLevel() |
int |
compareTo(Object that) |
MethodInfo[] |
constructors() |
ClassInfo |
containingClass() |
PackageInfo |
containingPackage() |
boolean |
containsMethod(MethodInfo method)
Returns true if the given method's signature is available in this class,
either directly or via inheritance.
|
TagInfo[] |
deprecatedTags() |
FieldInfo[] |
enumConstants() |
boolean |
equals(ClassInfo that) |
ClassInfo |
extendedFindClass(String className) |
FieldInfo[] |
fields() |
ClassInfo |
findClass(String className) |
FieldInfo |
findField(String name) |
ClassInfo |
findInnerClass(String className) |
MethodInfo |
findMethod(String name,
String[] params,
String[] dimensions,
boolean varargs) |
TagInfo[] |
firstSentenceTags() |
void |
gatherFields(ClassInfo owner,
ClassInfo cl,
HashMap<String,FieldInfo> fields) |
MethodInfo[] |
getHiddenMethods() |
ClassInfo[] |
getInterfaces() |
MethodInfo[] |
getNonWrittenConstructors() |
ClassInfo[] |
getRealInnerClasses() |
String |
getReasonIncluded() |
String |
getSource() |
TypeInfo[] |
getTypeParameters() |
boolean |
hasConstructor(MethodInfo constructor) |
Iterable<ClassInfo> |
hierarchy()
Returns the class hierarchy for this class, starting with this class.
|
void |
init(TypeInfo typeInfo,
ClassInfo[] interfaces,
TypeInfo[] interfaceTypes,
ClassInfo[] innerClasses,
MethodInfo[] constructors,
MethodInfo[] methods,
MethodInfo[] annotationElements,
FieldInfo[] fields,
FieldInfo[] enumConstants,
PackageInfo containingPackage,
ClassInfo containingClass,
ClassInfo superclass,
TypeInfo superclassType,
AnnotationInstanceInfo[] annotations) |
void |
init2() |
void |
init3(TypeInfo[] types,
ClassInfo[] realInnerClasses) |
TagInfo[] |
inlineTags() |
ClassInfo[] |
innerClasses() |
static MethodInfo |
interfaceMethod(MethodInfo candidate,
ClassInfo newClassObj) |
boolean |
isAbstract() |
boolean |
isAnnotation() |
boolean |
isConsistent(ClassInfo cl) |
boolean |
isDefinedLocally()
Returns true if the class represented by this object is defined
locally, and thus will be included in local documentation.
|
boolean |
isDeprecated() |
boolean |
isDerivedFrom(ClassInfo cl)
Even indirectly
|
boolean |
isEnum() |
boolean |
isError() |
boolean |
isException() |
boolean |
isFinal() |
boolean |
isHidden() |
boolean |
isHiddenImpl() |
boolean |
isInterface() |
boolean |
isOrdinaryClass() |
boolean |
isPackagePrivate() |
boolean |
isPrimitive() |
boolean |
isPrivate() |
boolean |
isProtected() |
boolean |
isPublic() |
boolean |
isStatic() |
String |
kind() |
String |
leafName() |
void |
makeHDF(com.google.clearsilver.jsilver.data.Data data)
Turns into the main class page
|
void |
makeKeywordEntries(List<com.google.doclava.KeywordEntry> keywords) |
static void |
makeLinkListHDF(com.google.clearsilver.jsilver.data.Data data,
String base,
ClassInfo[] classes) |
void |
makeShortDescrHDF(com.google.clearsilver.jsilver.data.Data data,
String base)
Used in lists of this class (packages, nested classes, known subclasses)
|
MethodInfo[] |
methods() |
String |
name() |
String[] |
nameParts() |
static MethodInfo |
overriddenMethod(MethodInfo candidate,
ClassInfo newClassObj) |
ContainerInfo |
parent() |
String |
qualifiedName() |
String |
qualifiedTypeName() |
ClassInfo[] |
realInterfaces() |
ClassInfo |
realSuperclass() |
String |
relativePath()
Returns the relative path that represents this item on a
documentation source.
|
String |
relativePath(String suffix) |
String |
scope() |
AttributeInfo[] |
selfAttributes() |
FieldInfo[] |
selfFields() |
MethodInfo[] |
selfMethods() |
void |
setAnnotations(AnnotationInstanceInfo[] annotations) |
void |
setContainingPackage(PackageInfo pkg) |
void |
setHiddenMethods(MethodInfo[] mInfo) |
void |
setNonWrittenConstructors(MethodInfo[] nonWritten) |
void |
setReasonIncluded(String reason) |
void |
setSuperClass(ClassInfo superclass) |
void |
setTypeInfo(TypeInfo typeInfo) |
static ClassInfo[] |
sortByName(ClassInfo[] classes) |
ClassInfo |
superclass() |
String |
superclassName() |
TypeInfo |
superclassType()
always the real superclass, not the collapsed one we get through superclass(), also has the
type parameter info if it's generic.
|
String |
toString() |
HashSet<String> |
typeVariables() |
addFederatedReference, comment, getFederatedReferences, getRawCommentText, getSince, htmlPage, isDocOnly, position, setFederatedReferences, setSince
public static final Comparator<ClassInfo> comparator
public static final Comparator<ClassInfo> qualifiedComparator
public ClassInfo(String qualifiedName)
public ClassInfo(com.sun.javadoc.ClassDoc cl, String rawCommentText, SourcePositionInfo position, boolean isPublic, boolean isProtected, boolean isPackagePrivate, boolean isPrivate, boolean isStatic, boolean isInterface, boolean isAbstract, boolean isOrdinaryClass, boolean isException, boolean isError, boolean isEnum, boolean isAnnotation, boolean isFinal, boolean isIncluded, String name, String qualifiedName, String qualifiedTypeName, boolean isPrimitive)
public void init(TypeInfo typeInfo, ClassInfo[] interfaces, TypeInfo[] interfaceTypes, ClassInfo[] innerClasses, MethodInfo[] constructors, MethodInfo[] methods, MethodInfo[] annotationElements, FieldInfo[] fields, FieldInfo[] enumConstants, PackageInfo containingPackage, ClassInfo containingClass, ClassInfo superclass, TypeInfo superclassType, AnnotationInstanceInfo[] annotations)
public void init2()
public ClassInfo[] getRealInnerClasses()
public TypeInfo[] getTypeParameters()
public boolean checkLevel()
checkLevel
in interface ContainerInfo
public int compareTo(Object that)
compareTo
in interface Comparable
public ContainerInfo parent()
public boolean isProtected()
isProtected
in interface Scoped
public boolean isPackagePrivate()
isPackagePrivate
in interface Scoped
public boolean isStatic()
public boolean isInterface()
public boolean isAbstract()
public PackageInfo containingPackage()
public ClassInfo containingClass()
public boolean isOrdinaryClass()
public boolean isException()
public boolean isError()
public boolean isEnum()
public boolean isAnnotation()
public boolean isFinal()
public boolean isDefinedLocally()
isDefinedLocally
in class DocInfo
public ClassInfo[] getInterfaces()
public ClassInfo[] realInterfaces()
public String name()
public String[] nameParts()
public String leafName()
public String qualifiedName()
qualifiedName
in interface ContainerInfo
public String qualifiedTypeName()
public boolean isPrimitive()
public MethodInfo[] allConstructors()
public MethodInfo[] constructors()
public ClassInfo[] innerClasses()
public TagInfo[] inlineTags()
public TagInfo[] firstSentenceTags()
public boolean isDeprecated()
public TagInfo[] deprecatedTags()
public MethodInfo[] methods()
public MethodInfo[] annotationElements()
public AnnotationInstanceInfo[] annotations()
public FieldInfo[] fields()
public void gatherFields(ClassInfo owner, ClassInfo cl, HashMap<String,FieldInfo> fields)
public FieldInfo[] selfFields()
public FieldInfo[] allSelfFields()
public MethodInfo[] selfMethods()
public MethodInfo[] allSelfMethods()
public void addMethod(MethodInfo method)
public void setContainingPackage(PackageInfo pkg)
public AttributeInfo[] selfAttributes()
public FieldInfo[] enumConstants()
public ClassInfo superclass()
public ClassInfo realSuperclass()
public TypeInfo superclassType()
public TypeInfo asTypeInfo()
public String relativePath()
DocInfo
relativePath
in class DocInfo
public boolean isDerivedFrom(ClassInfo cl)
public void makeKeywordEntries(List<com.google.doclava.KeywordEntry> keywords)
public static void makeLinkListHDF(com.google.clearsilver.jsilver.data.Data data, String base, ClassInfo[] classes)
public void makeShortDescrHDF(com.google.clearsilver.jsilver.data.Data data, String base)
public void makeHDF(com.google.clearsilver.jsilver.data.Data data)
public boolean isHidden()
public boolean isHiddenImpl()
public MethodInfo findMethod(String name, String[] params, String[] dimensions, boolean varargs)
public boolean containsMethod(MethodInfo method)
public boolean equals(ClassInfo that)
public void setNonWrittenConstructors(MethodInfo[] nonWritten)
public MethodInfo[] getNonWrittenConstructors()
public String kind()
public String scope()
public void setHiddenMethods(MethodInfo[] mInfo)
public MethodInfo[] getHiddenMethods()
public void setReasonIncluded(String reason)
public String getReasonIncluded()
public void addInterface(ClassInfo iface)
public void addConstructor(ConstructorInfo cInfo)
public void addField(FieldInfo fInfo)
public void setSuperClass(ClassInfo superclass)
public Map<String,ConstructorInfo> allConstructorsMap()
public Map<String,MethodInfo> allMethods()
methods()
.public Iterable<ClassInfo> hierarchy()
public String superclassName()
public void setAnnotations(AnnotationInstanceInfo[] annotations)
public boolean isConsistent(ClassInfo cl)
public static MethodInfo overriddenMethod(MethodInfo candidate, ClassInfo newClassObj)
public static MethodInfo interfaceMethod(MethodInfo candidate, ClassInfo newClassObj)
public boolean hasConstructor(MethodInfo constructor)
public void setTypeInfo(TypeInfo typeInfo)
public String getSource() throws IOException
IOException
Copyright © 2010-2014 Google. All Rights Reserved.