WrappedClassDoc (UMLGraph 1.0.0 API)

java.lang.Object
- org.umlgraph.doclet.WrappedClassDoc

```
public class WrappedClassDoc
extends java.lang.Object
```
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.

Constructor Summary

Constructors
Constructor and Description

WrappedClassDoc(ClassDoc wrapped)

Constructors
Constructor and Description
`WrappedClassDoc(ClassDoc wrapped)`

Method Summary

Methods
Modifier and Type	Method and Description
`AnnotationDesc[]`	`annotations()`
`AnnotatedType`	`asAnnotatedType()`
`AnnotationTypeDoc`	`asAnnotationTypeDoc()`
`ClassDoc`	`asClassDoc()`
`ParameterizedType`	`asParameterizedType()`
`TypeVariable`	`asTypeVariable()`
`WildcardType`	`asWildcardType()`
`java.lang.String`	`commentText()`
`int`	`compareTo(java.lang.Object arg0)`
`ConstructorDoc[]`	`constructors()`
`ConstructorDoc[]`	`constructors(boolean arg0)`
`ClassDoc`	`containingClass()`
`PackageDoc`	`containingPackage()`
`boolean`	`definesSerializableFields()`
`java.lang.String`	`dimension()`
`FieldDoc[]`	`enumConstants()`
`FieldDoc[]`	`fields()`
`FieldDoc[]`	`fields(boolean arg0)`
`ClassDoc`	`findClass(java.lang.String arg0)`
`Tag[]`	`firstSentenceTags()`
`Type`	`getElementType()`
`java.lang.String`	`getRawCommentText()`
`ClassDoc[]`	`importedClasses()` Deprecated.
`PackageDoc[]`	`importedPackages()` Deprecated.
`Tag[]`	`inlineTags()`
`ClassDoc[]`	`innerClasses()`
`ClassDoc[]`	`innerClasses(boolean arg0)`
`ClassDoc[]`	`interfaces()`
`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()`
`MethodDoc[]`	`methods()`
`MethodDoc[]`	`methods(boolean arg0)`
`java.lang.String`	`modifiers()`
`int`	`modifierSpecifier()`
`java.lang.String`	`name()`
`SourcePosition`	`position()`
`java.lang.String`	`qualifiedName()`
`java.lang.String`	`qualifiedTypeName()`
`SeeTag[]`	`seeTags()`
`FieldDoc[]`	`serializableFields()`
`MethodDoc[]`	`serializationMethods()`
`void`	`setRawCommentText(java.lang.String arg0)`
`java.lang.String`	`simpleTypeName()`
`boolean`	`subclassOf(ClassDoc arg0)`
`ClassDoc`	`superclass()`
`Type`	`superclassType()`
`Tag[]`	`tags()`
`Tag[]`	`tags(java.lang.String arg0)`
`java.lang.String`	`toString()`
`java.lang.String`	`typeName()`
`TypeVariable[]`	`typeParameters()`
`ParamTag[]`	`typeParamTags()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WrappedClassDoc

public WrappedClassDoc(ClassDoc wrapped)

Method Detail

annotations
```
public AnnotationDesc[] annotations()
```

asAnnotationTypeDoc

public AnnotationTypeDoc asAnnotationTypeDoc()

getElementType
```
public Type getElementType()
```

asClassDoc
```
public ClassDoc asClassDoc()
```

asParameterizedType

public ParameterizedType asParameterizedType()

asTypeVariable
```
public TypeVariable asTypeVariable()
```

asWildcardType
```
public WildcardType asWildcardType()
```

asAnnotatedType

public AnnotatedType asAnnotatedType()

commentText
```
public java.lang.String commentText()
```

compareTo

public int compareTo(java.lang.Object arg0)

constructors

public ConstructorDoc[] constructors()

constructors

public ConstructorDoc[] constructors(boolean arg0)

containingClass
```
public ClassDoc containingClass()
```

containingPackage
```
public PackageDoc containingPackage()
```

definesSerializableFields

public boolean definesSerializableFields()

dimension
```
public java.lang.String dimension()
```

enumConstants
```
public FieldDoc[] enumConstants()
```

fields
```
public FieldDoc[] fields()
```

fields

public FieldDoc[] fields(boolean arg0)

findClass

public ClassDoc findClass(java.lang.String arg0)

firstSentenceTags
```
public Tag[] firstSentenceTags()
```

getRawCommentText

public java.lang.String getRawCommentText()

importedClasses

@Deprecated
public ClassDoc[] importedClasses()

Deprecated.

importedPackages

@Deprecated
public PackageDoc[] importedPackages()

Deprecated.

inlineTags
```
public Tag[] inlineTags()
```

innerClasses
```
public ClassDoc[] innerClasses()
```

innerClasses

public ClassDoc[] innerClasses(boolean arg0)

interfaces
```
public ClassDoc[] interfaces()
```

interfaceTypes
```
public Type[] interfaceTypes()
```

isAbstract
```
public boolean isAbstract()
```

isAnnotationType
```
public boolean isAnnotationType()
```

isAnnotationTypeElement

public boolean isAnnotationTypeElement()

isClass
```
public boolean isClass()
```

isConstructor
```
public boolean isConstructor()
```

isEnum
```
public boolean isEnum()
```

isEnumConstant
```
public boolean isEnumConstant()
```

isError
```
public boolean isError()
```

isException
```
public boolean isException()
```

isExternalizable
```
public boolean isExternalizable()
```

isField
```
public boolean isField()
```

isFinal
```
public boolean isFinal()
```

isIncluded
```
public boolean isIncluded()
```

isInterface
```
public boolean isInterface()
```

isMethod
```
public boolean isMethod()
```

isOrdinaryClass
```
public boolean isOrdinaryClass()
```

isPackagePrivate
```
public boolean isPackagePrivate()
```

isPrimitive
```
public boolean isPrimitive()
```

isPrivate
```
public boolean isPrivate()
```

isProtected
```
public boolean isProtected()
```

isPublic
```
public boolean isPublic()
```

isSerializable
```
public boolean isSerializable()
```

isStatic
```
public boolean isStatic()
```

methods
```
public MethodDoc[] methods()
```

methods

public MethodDoc[] methods(boolean arg0)

modifiers
```
public java.lang.String modifiers()
```

modifierSpecifier
```
public int modifierSpecifier()
```

name
```
public java.lang.String name()
```

position
```
public SourcePosition position()
```

qualifiedName

public java.lang.String qualifiedName()

qualifiedTypeName

public java.lang.String qualifiedTypeName()

seeTags
```
public SeeTag[] seeTags()
```

serializableFields

public FieldDoc[] serializableFields()

serializationMethods

public MethodDoc[] serializationMethods()

setRawCommentText

public void setRawCommentText(java.lang.String arg0)

simpleTypeName

public java.lang.String simpleTypeName()

subclassOf

public boolean subclassOf(ClassDoc arg0)

superclass
```
public ClassDoc superclass()
```

superclassType
```
public Type superclassType()
```

tags
```
public Tag[] tags()
```

typeParameters

public TypeVariable[] typeParameters()

typeParamTags
```
public ParamTag[] typeParamTags()
```

Class WrappedClassDoc

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WrappedClassDoc

Method Detail

annotations

asAnnotationTypeDoc

getElementType

asClassDoc

asParameterizedType

asTypeVariable

asWildcardType

asAnnotatedType

commentText

compareTo

constructors

constructors

containingClass

containingPackage

definesSerializableFields

dimension

enumConstants

fields

fields

findClass

firstSentenceTags

getRawCommentText

importedClasses

importedPackages

inlineTags

innerClasses

innerClasses

interfaces

interfaceTypes

isAbstract

isAnnotationType

isAnnotationTypeElement

isClass

isConstructor

isEnum

isEnumConstant

isError

isException

isExternalizable

isField

isFinal

isIncluded

isInterface

isMethod

isOrdinaryClass

isPackagePrivate

isPrimitive

isPrivate

isProtected

isPublic

isSerializable

isStatic

methods

methods

modifiers

modifierSpecifier

name

position

qualifiedName

qualifiedTypeName

seeTags

serializableFields

serializationMethods

setRawCommentText

simpleTypeName

subclassOf

superclass

superclassType

tags

tags

toString

typeName

typeParameters