org.umlgraph.doclet

Class WrappedClassDoc

Show UML class diagram

java.lang.Object

org.umlgraph.doclet.WrappedClassDoc

All Implemented Interfaces:

com.sun.javadoc.ClassDoc, com.sun.javadoc.Doc, com.sun.javadoc.ProgramElementDoc, com.sun.javadoc.Type, java.lang.Comparable<java.lang.Object>

public class WrappedClassDoc
extends java.lang.Object
implements com.sun.javadoc.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.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	name
(package private) com.sun.javadoc.Tag[]	tags
(package private) java.lang.String	toString
(package private) com.sun.javadoc.ClassDoc	wrapped

Constructor Summary

Constructors

Constructor and Description
WrappedClassDoc(com.sun.javadoc.ClassDoc wrapped)

Method Summary

Modifier and Type	Method and Description
com.sun.javadoc.AnnotationDesc[]	annotations()
com.sun.javadoc.AnnotatedType	asAnnotatedType()
com.sun.javadoc.AnnotationTypeDoc	asAnnotationTypeDoc()
com.sun.javadoc.ClassDoc	asClassDoc()
com.sun.javadoc.ParameterizedType	asParameterizedType()
com.sun.javadoc.TypeVariable	asTypeVariable()
com.sun.javadoc.WildcardType	asWildcardType()
java.lang.String	commentText()
int	compareTo(java.lang.Object arg0)
com.sun.javadoc.ConstructorDoc[]	constructors()
com.sun.javadoc.ConstructorDoc[]	constructors(boolean arg0)
com.sun.javadoc.ClassDoc	containingClass()
com.sun.javadoc.PackageDoc	containingPackage()
boolean	definesSerializableFields()
java.lang.String	dimension()
com.sun.javadoc.FieldDoc[]	enumConstants()
com.sun.javadoc.FieldDoc[]	fields()
com.sun.javadoc.FieldDoc[]	fields(boolean arg0)
com.sun.javadoc.ClassDoc	findClass(java.lang.String arg0)
com.sun.javadoc.Tag[]	firstSentenceTags()
com.sun.javadoc.Type	getElementType()
java.lang.String	getRawCommentText()
com.sun.javadoc.ClassDoc[]	importedClasses() Deprecated.
com.sun.javadoc.PackageDoc[]	importedPackages() Deprecated.
com.sun.javadoc.Tag[]	inlineTags()
com.sun.javadoc.ClassDoc[]	innerClasses()
com.sun.javadoc.ClassDoc[]	innerClasses(boolean arg0)
com.sun.javadoc.ClassDoc[]	interfaces()
com.sun.javadoc.Type[]	interfaceTypes()
boolean	isAbstract()
boolean	isAnnotationType()
boolean	isAnnotationTypeElement()
boolean	isClass()
boolean	isConstructor()
boolean	isEnum()
boolean	isEnumConstant()
boolean	isError()
boolean	isException()
boolean	isExternalizable()
boolean	isField()
boolean	isFinal()
boolean	isIncluded()
boolean	isInterface()
boolean	isMethod()
boolean	isOrdinaryClass()
boolean	isPackagePrivate()
boolean	isPrimitive()
boolean	isPrivate()
boolean	isProtected()
boolean	isPublic()
boolean	isSerializable()
boolean	isStatic()
com.sun.javadoc.MethodDoc[]	methods()
com.sun.javadoc.MethodDoc[]	methods(boolean arg0)
java.lang.String	modifiers()
int	modifierSpecifier()
java.lang.String	name()
com.sun.javadoc.SourcePosition	position()
java.lang.String	qualifiedName()
java.lang.String	qualifiedTypeName()
com.sun.javadoc.SeeTag[]	seeTags()
com.sun.javadoc.FieldDoc[]	serializableFields()
com.sun.javadoc.MethodDoc[]	serializationMethods()
void	setRawCommentText(java.lang.String arg0)
java.lang.String	simpleTypeName()
boolean	subclassOf(com.sun.javadoc.ClassDoc arg0)
com.sun.javadoc.ClassDoc	superclass()
com.sun.javadoc.Type	superclassType()
com.sun.javadoc.Tag[]	tags()
com.sun.javadoc.Tag[]	tags(java.lang.String arg0)
java.lang.String	toString()
java.lang.String	typeName()
com.sun.javadoc.TypeVariable[]	typeParameters()
com.sun.javadoc.ParamTag[]	typeParamTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

wrapped

com.sun.javadoc.ClassDoc wrapped

toString

java.lang.String toString

name

java.lang.String name

tags

com.sun.javadoc.Tag[] tags

Constructor Detail

WrappedClassDoc

public WrappedClassDoc(com.sun.javadoc.ClassDoc wrapped)

Method Detail

annotations

public com.sun.javadoc.AnnotationDesc[] annotations()

Specified by:

annotations in interface com.sun.javadoc.ProgramElementDoc

asAnnotationTypeDoc

public com.sun.javadoc.AnnotationTypeDoc asAnnotationTypeDoc()

Specified by:

asAnnotationTypeDoc in interface com.sun.javadoc.Type

asClassDoc

public com.sun.javadoc.ClassDoc asClassDoc()

Specified by:

asClassDoc in interface com.sun.javadoc.Type

asParameterizedType

public com.sun.javadoc.ParameterizedType asParameterizedType()

Specified by:

asParameterizedType in interface com.sun.javadoc.Type

asTypeVariable

public com.sun.javadoc.TypeVariable asTypeVariable()

Specified by:

asTypeVariable in interface com.sun.javadoc.Type

asWildcardType

public com.sun.javadoc.WildcardType asWildcardType()

Specified by:

asWildcardType in interface com.sun.javadoc.Type

commentText

public java.lang.String commentText()

Specified by:

commentText in interface com.sun.javadoc.Doc

compareTo

public int compareTo(java.lang.Object arg0)

Specified by:

compareTo in interface com.sun.javadoc.Doc

Specified by:

compareTo in interface java.lang.Comparable<java.lang.Object>

constructors

public com.sun.javadoc.ConstructorDoc[] constructors()

Specified by:

constructors in interface com.sun.javadoc.ClassDoc

constructors

public com.sun.javadoc.ConstructorDoc[] constructors(boolean arg0)

Specified by:

constructors in interface com.sun.javadoc.ClassDoc

containingClass

public com.sun.javadoc.ClassDoc containingClass()

Specified by:

containingClass in interface com.sun.javadoc.ProgramElementDoc

containingPackage

public com.sun.javadoc.PackageDoc containingPackage()

Specified by:

containingPackage in interface com.sun.javadoc.ProgramElementDoc

definesSerializableFields

public boolean definesSerializableFields()

Specified by:

definesSerializableFields in interface com.sun.javadoc.ClassDoc

dimension

public java.lang.String dimension()

Specified by:

dimension in interface com.sun.javadoc.Type

enumConstants

public com.sun.javadoc.FieldDoc[] enumConstants()

Specified by:

enumConstants in interface com.sun.javadoc.ClassDoc

fields

public com.sun.javadoc.FieldDoc[] fields()

Specified by:

fields in interface com.sun.javadoc.ClassDoc

fields

public com.sun.javadoc.FieldDoc[] fields(boolean arg0)

Specified by:

fields in interface com.sun.javadoc.ClassDoc

findClass

public com.sun.javadoc.ClassDoc findClass(java.lang.String arg0)

Specified by:

findClass in interface com.sun.javadoc.ClassDoc

firstSentenceTags

public com.sun.javadoc.Tag[] firstSentenceTags()

Specified by:

firstSentenceTags in interface com.sun.javadoc.Doc

getRawCommentText

public java.lang.String getRawCommentText()

Specified by:

getRawCommentText in interface com.sun.javadoc.Doc

importedClasses

@Deprecated
public com.sun.javadoc.ClassDoc[] importedClasses()

Deprecated.

Specified by:

importedClasses in interface com.sun.javadoc.ClassDoc

importedPackages

@Deprecated
public com.sun.javadoc.PackageDoc[] importedPackages()

Deprecated.

Specified by:

importedPackages in interface com.sun.javadoc.ClassDoc

inlineTags

public com.sun.javadoc.Tag[] inlineTags()

Specified by:

inlineTags in interface com.sun.javadoc.Doc

innerClasses

public com.sun.javadoc.ClassDoc[] innerClasses()

Specified by:

innerClasses in interface com.sun.javadoc.ClassDoc

innerClasses

public com.sun.javadoc.ClassDoc[] innerClasses(boolean arg0)

Specified by:

innerClasses in interface com.sun.javadoc.ClassDoc

interfaces

public com.sun.javadoc.ClassDoc[] interfaces()

Specified by:

interfaces in interface com.sun.javadoc.ClassDoc

interfaceTypes

public com.sun.javadoc.Type[] interfaceTypes()

Specified by:

interfaceTypes in interface com.sun.javadoc.ClassDoc

isAbstract

public boolean isAbstract()

Specified by:

isAbstract in interface com.sun.javadoc.ClassDoc

isAnnotationType

public boolean isAnnotationType()

Specified by:

isAnnotationType in interface com.sun.javadoc.Doc

isAnnotationTypeElement

public boolean isAnnotationTypeElement()

Specified by:

isAnnotationTypeElement in interface com.sun.javadoc.Doc

isClass

public boolean isClass()

Specified by:

isClass in interface com.sun.javadoc.Doc

isConstructor

public boolean isConstructor()

Specified by:

isConstructor in interface com.sun.javadoc.Doc

isEnum

public boolean isEnum()

Specified by:

isEnum in interface com.sun.javadoc.Doc

isEnumConstant

public boolean isEnumConstant()

Specified by:

isEnumConstant in interface com.sun.javadoc.Doc

isError

public boolean isError()

Specified by:

isError in interface com.sun.javadoc.Doc

isException

public boolean isException()

Specified by:

isException in interface com.sun.javadoc.Doc

isExternalizable

public boolean isExternalizable()

Specified by:

isExternalizable in interface com.sun.javadoc.ClassDoc

isField

public boolean isField()

Specified by:

isField in interface com.sun.javadoc.Doc

isFinal

public boolean isFinal()

Specified by:

isFinal in interface com.sun.javadoc.ProgramElementDoc

isIncluded

public boolean isIncluded()

Specified by:

isIncluded in interface com.sun.javadoc.Doc

isInterface

public boolean isInterface()

Specified by:

isInterface in interface com.sun.javadoc.Doc

isMethod

public boolean isMethod()

Specified by:

isMethod in interface com.sun.javadoc.Doc

isOrdinaryClass

public boolean isOrdinaryClass()

Specified by:

isOrdinaryClass in interface com.sun.javadoc.Doc

isPackagePrivate

public boolean isPackagePrivate()

Specified by:

isPackagePrivate in interface com.sun.javadoc.ProgramElementDoc

isPrimitive

public boolean isPrimitive()

Specified by:

isPrimitive in interface com.sun.javadoc.Type

isPrivate

public boolean isPrivate()

Specified by:

isPrivate in interface com.sun.javadoc.ProgramElementDoc

isProtected

public boolean isProtected()

Specified by:

isProtected in interface com.sun.javadoc.ProgramElementDoc

isPublic

public boolean isPublic()

Specified by:

isPublic in interface com.sun.javadoc.ProgramElementDoc

isSerializable

public boolean isSerializable()

Specified by:

isSerializable in interface com.sun.javadoc.ClassDoc

isStatic

public boolean isStatic()

Specified by:

isStatic in interface com.sun.javadoc.ProgramElementDoc

methods

public com.sun.javadoc.MethodDoc[] methods()

Specified by:

methods in interface com.sun.javadoc.ClassDoc

methods

public com.sun.javadoc.MethodDoc[] methods(boolean arg0)

Specified by:

methods in interface com.sun.javadoc.ClassDoc

modifiers

public java.lang.String modifiers()

Specified by:

modifiers in interface com.sun.javadoc.ProgramElementDoc

modifierSpecifier

public int modifierSpecifier()

Specified by:

modifierSpecifier in interface com.sun.javadoc.ProgramElementDoc

name

public java.lang.String name()

Specified by:

name in interface com.sun.javadoc.Doc

position

public com.sun.javadoc.SourcePosition position()

Specified by:

position in interface com.sun.javadoc.Doc

qualifiedName

public java.lang.String qualifiedName()

Specified by:

qualifiedName in interface com.sun.javadoc.ProgramElementDoc

qualifiedTypeName

public java.lang.String qualifiedTypeName()

Specified by:

qualifiedTypeName in interface com.sun.javadoc.Type

seeTags

public com.sun.javadoc.SeeTag[] seeTags()

Specified by:

seeTags in interface com.sun.javadoc.Doc

serializableFields

public com.sun.javadoc.FieldDoc[] serializableFields()

Specified by:

serializableFields in interface com.sun.javadoc.ClassDoc

serializationMethods

public com.sun.javadoc.MethodDoc[] serializationMethods()

Specified by:

serializationMethods in interface com.sun.javadoc.ClassDoc

setRawCommentText

public void setRawCommentText(java.lang.String arg0)

Specified by:

setRawCommentText in interface com.sun.javadoc.Doc

simpleTypeName

public java.lang.String simpleTypeName()

Specified by:

simpleTypeName in interface com.sun.javadoc.Type

subclassOf

public boolean subclassOf(com.sun.javadoc.ClassDoc arg0)

Specified by:

subclassOf in interface com.sun.javadoc.ClassDoc

superclass

public com.sun.javadoc.ClassDoc superclass()

Specified by:

superclass in interface com.sun.javadoc.ClassDoc

superclassType

public com.sun.javadoc.Type superclassType()

Specified by:

superclassType in interface com.sun.javadoc.ClassDoc

tags

public com.sun.javadoc.Tag[] tags()

Specified by:

tags in interface com.sun.javadoc.Doc

tags

public com.sun.javadoc.Tag[] tags(java.lang.String arg0)

Specified by:

tags in interface com.sun.javadoc.Doc

toString

public java.lang.String toString()

Specified by:

toString in interface com.sun.javadoc.Type

Overrides:

toString in class java.lang.Object

typeName

public java.lang.String typeName()

Specified by:

typeName in interface com.sun.javadoc.Type

typeParameters

public com.sun.javadoc.TypeVariable[] typeParameters()

Specified by:

typeParameters in interface com.sun.javadoc.ClassDoc

typeParamTags

public com.sun.javadoc.ParamTag[] typeParamTags()

Specified by:

typeParamTags in interface com.sun.javadoc.ClassDoc

asAnnotatedType

public com.sun.javadoc.AnnotatedType asAnnotatedType()

Specified by:

asAnnotatedType in interface com.sun.javadoc.Type

getElementType

public com.sun.javadoc.Type getElementType()

Specified by:

getElementType in interface com.sun.javadoc.Type