org.umlgraph.doclet
Class WrappedClassDoc
java.lang.Object
org.umlgraph.doclet.WrappedClassDoc
- All Implemented Interfaces:
- ClassDoc, Doc, ProgramElementDoc, Type, Comparable<Object>
public class WrappedClassDoc
- extends Object
- implements ClassDoc
A ClassDoc wrapper that caches answer to the most common requests performed
by UMLGraph, considerably improving the overall UMLDoc performance (ClassDoc
computes most of the results for more fine grained information at each call).
Unfortunately this has a side effect, since it breaks the equals() call between
plain ClassDoc instances and WrappedClassDoc ones, so use it with due care.
In particular, don't provide WrappedClassDoc instances to the standard doclet.
wrapped
ClassDoc wrapped
toString
String toString
name
String name
tags
Tag[] tags
WrappedClassDoc
public WrappedClassDoc(ClassDoc wrapped)
annotations
public AnnotationDesc[] annotations()
- Specified by:
annotations
in interface ProgramElementDoc
asAnnotationTypeDoc
public AnnotationTypeDoc asAnnotationTypeDoc()
- Specified by:
asAnnotationTypeDoc
in interface Type
asClassDoc
public ClassDoc asClassDoc()
- Specified by:
asClassDoc
in interface Type
asParameterizedType
public ParameterizedType asParameterizedType()
- Specified by:
asParameterizedType
in interface Type
asTypeVariable
public TypeVariable asTypeVariable()
- Specified by:
asTypeVariable
in interface Type
asWildcardType
public WildcardType asWildcardType()
- Specified by:
asWildcardType
in interface Type
commentText
public String commentText()
- Specified by:
commentText
in interface Doc
compareTo
public int compareTo(Object arg0)
- Specified by:
compareTo
in interface Doc
- Specified by:
compareTo
in interface Comparable<Object>
constructors
public ConstructorDoc[] constructors()
- Specified by:
constructors
in interface ClassDoc
constructors
public ConstructorDoc[] constructors(boolean arg0)
- Specified by:
constructors
in interface ClassDoc
containingClass
public ClassDoc containingClass()
- Specified by:
containingClass
in interface ProgramElementDoc
containingPackage
public PackageDoc containingPackage()
- Specified by:
containingPackage
in interface ProgramElementDoc
definesSerializableFields
public boolean definesSerializableFields()
- Specified by:
definesSerializableFields
in interface ClassDoc
dimension
public String dimension()
- Specified by:
dimension
in interface Type
enumConstants
public FieldDoc[] enumConstants()
- Specified by:
enumConstants
in interface ClassDoc
fields
public FieldDoc[] fields()
- Specified by:
fields
in interface ClassDoc
fields
public FieldDoc[] fields(boolean arg0)
- Specified by:
fields
in interface ClassDoc
findClass
public ClassDoc findClass(String arg0)
- Specified by:
findClass
in interface ClassDoc
firstSentenceTags
public Tag[] firstSentenceTags()
- Specified by:
firstSentenceTags
in interface Doc
getRawCommentText
public String getRawCommentText()
- Specified by:
getRawCommentText
in interface Doc
importedClasses
@Deprecated
public ClassDoc[] importedClasses()
- Deprecated.
- Specified by:
importedClasses
in interface ClassDoc
importedPackages
@Deprecated
public PackageDoc[] importedPackages()
- Deprecated.
- Specified by:
importedPackages
in interface ClassDoc
inlineTags
public Tag[] inlineTags()
- Specified by:
inlineTags
in interface Doc
innerClasses
public ClassDoc[] innerClasses()
- Specified by:
innerClasses
in interface ClassDoc
innerClasses
public ClassDoc[] innerClasses(boolean arg0)
- Specified by:
innerClasses
in interface ClassDoc
interfaces
public ClassDoc[] interfaces()
- Specified by:
interfaces
in interface ClassDoc
interfaceTypes
public Type[] interfaceTypes()
- Specified by:
interfaceTypes
in interface ClassDoc
isAbstract
public boolean isAbstract()
- Specified by:
isAbstract
in interface ClassDoc
isAnnotationType
public boolean isAnnotationType()
- Specified by:
isAnnotationType
in interface Doc
isAnnotationTypeElement
public boolean isAnnotationTypeElement()
- Specified by:
isAnnotationTypeElement
in interface Doc
isClass
public boolean isClass()
- Specified by:
isClass
in interface Doc
isConstructor
public boolean isConstructor()
- Specified by:
isConstructor
in interface Doc
isEnum
public boolean isEnum()
- Specified by:
isEnum
in interface Doc
isEnumConstant
public boolean isEnumConstant()
- Specified by:
isEnumConstant
in interface Doc
isError
public boolean isError()
- Specified by:
isError
in interface Doc
isException
public boolean isException()
- Specified by:
isException
in interface Doc
isExternalizable
public boolean isExternalizable()
- Specified by:
isExternalizable
in interface ClassDoc
isField
public boolean isField()
- Specified by:
isField
in interface Doc
isFinal
public boolean isFinal()
- Specified by:
isFinal
in interface ProgramElementDoc
isIncluded
public boolean isIncluded()
- Specified by:
isIncluded
in interface Doc
isInterface
public boolean isInterface()
- Specified by:
isInterface
in interface Doc
isMethod
public boolean isMethod()
- Specified by:
isMethod
in interface Doc
isOrdinaryClass
public boolean isOrdinaryClass()
- Specified by:
isOrdinaryClass
in interface Doc
isPackagePrivate
public boolean isPackagePrivate()
- Specified by:
isPackagePrivate
in interface ProgramElementDoc
isPrimitive
public boolean isPrimitive()
- Specified by:
isPrimitive
in interface Type
isPrivate
public boolean isPrivate()
- Specified by:
isPrivate
in interface ProgramElementDoc
isProtected
public boolean isProtected()
- Specified by:
isProtected
in interface ProgramElementDoc
isPublic
public boolean isPublic()
- Specified by:
isPublic
in interface ProgramElementDoc
isSerializable
public boolean isSerializable()
- Specified by:
isSerializable
in interface ClassDoc
isStatic
public boolean isStatic()
- Specified by:
isStatic
in interface ProgramElementDoc
methods
public MethodDoc[] methods()
- Specified by:
methods
in interface ClassDoc
methods
public MethodDoc[] methods(boolean arg0)
- Specified by:
methods
in interface ClassDoc
modifiers
public String modifiers()
- Specified by:
modifiers
in interface ProgramElementDoc
modifierSpecifier
public int modifierSpecifier()
- Specified by:
modifierSpecifier
in interface ProgramElementDoc
name
public String name()
- Specified by:
name
in interface Doc
position
public SourcePosition position()
- Specified by:
position
in interface Doc
qualifiedName
public String qualifiedName()
- Specified by:
qualifiedName
in interface ProgramElementDoc
qualifiedTypeName
public String qualifiedTypeName()
- Specified by:
qualifiedTypeName
in interface Type
seeTags
public SeeTag[] seeTags()
- Specified by:
seeTags
in interface Doc
serializableFields
public FieldDoc[] serializableFields()
- Specified by:
serializableFields
in interface ClassDoc
serializationMethods
public MethodDoc[] serializationMethods()
- Specified by:
serializationMethods
in interface ClassDoc
setRawCommentText
public void setRawCommentText(String arg0)
- Specified by:
setRawCommentText
in interface Doc
simpleTypeName
public String simpleTypeName()
- Specified by:
simpleTypeName
in interface Type
subclassOf
public boolean subclassOf(ClassDoc arg0)
- Specified by:
subclassOf
in interface ClassDoc
superclass
public ClassDoc superclass()
- Specified by:
superclass
in interface ClassDoc
superclassType
public Type superclassType()
- Specified by:
superclassType
in interface ClassDoc
tags
public Tag[] tags()
- Specified by:
tags
in interface Doc
tags
public Tag[] tags(String arg0)
- Specified by:
tags
in interface Doc
toString
public String toString()
- Specified by:
toString
in interface Type
- Overrides:
toString
in class Object
typeName
public String typeName()
- Specified by:
typeName
in interface Type
typeParameters
public TypeVariable[] typeParameters()
- Specified by:
typeParameters
in interface ClassDoc
typeParamTags
public ParamTag[] typeParamTags()
- Specified by:
typeParamTags
in interface ClassDoc