org.umlgraph.doclet

Class WrappedRootDoc

Show UML class diagram

java.lang.Object

org.umlgraph.doclet.WrappedRootDoc

All Implemented Interfaces:

com.sun.javadoc.Doc, com.sun.javadoc.DocErrorReporter, com.sun.javadoc.RootDoc, java.lang.Comparable<java.lang.Object>

public class WrappedRootDoc
extends java.lang.Object
implements com.sun.javadoc.RootDoc

RootDoc wrapper that provides WrappedClassDoc instances instead of plain ClassDoc in order to optimize the overall performance of UMLDoc.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) com.sun.javadoc.RootDoc	wrapped
(package private) WrappedClassDoc[]	wrappedClassDocs

Constructor Summary

Constructors

Constructor and Description
WrappedRootDoc(com.sun.javadoc.RootDoc wrapped)

Method Summary

Modifier and Type	Method and Description
com.sun.javadoc.ClassDoc[]	classes()
com.sun.javadoc.ClassDoc	classNamed(java.lang.String arg0)
java.lang.String	commentText()
int	compareTo(java.lang.Object arg0)
com.sun.javadoc.Tag[]	firstSentenceTags()
java.lang.String	getRawCommentText()
com.sun.javadoc.Tag[]	inlineTags()
boolean	isAnnotationType()
boolean	isAnnotationTypeElement()
boolean	isClass()
boolean	isConstructor()
boolean	isEnum()
boolean	isEnumConstant()
boolean	isError()
boolean	isException()
boolean	isField()
boolean	isIncluded()
boolean	isInterface()
boolean	isMethod()
boolean	isOrdinaryClass()
java.lang.String	name()
java.lang.String[][]	options()
com.sun.javadoc.PackageDoc	packageNamed(java.lang.String arg0)
com.sun.javadoc.SourcePosition	position()
void	printError(com.sun.javadoc.SourcePosition arg0, java.lang.String arg1)
void	printError(java.lang.String arg0)
void	printNotice(com.sun.javadoc.SourcePosition arg0, java.lang.String arg1)
void	printNotice(java.lang.String arg0)
void	printWarning(com.sun.javadoc.SourcePosition arg0, java.lang.String arg1)
void	printWarning(java.lang.String arg0)
com.sun.javadoc.SeeTag[]	seeTags()
void	setRawCommentText(java.lang.String arg0)
com.sun.javadoc.ClassDoc[]	specifiedClasses()
com.sun.javadoc.PackageDoc[]	specifiedPackages()
com.sun.javadoc.Tag[]	tags()
com.sun.javadoc.Tag[]	tags(java.lang.String arg0)

Methods inherited from class java.lang.Object

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

Field Detail

wrapped

com.sun.javadoc.RootDoc wrapped

wrappedClassDocs

WrappedClassDoc[] wrappedClassDocs

Constructor Detail

WrappedRootDoc

public WrappedRootDoc(com.sun.javadoc.RootDoc wrapped)

Method Detail

classes

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

Specified by:

classes in interface com.sun.javadoc.RootDoc

classNamed

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

Specified by:

classNamed in interface com.sun.javadoc.RootDoc

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>

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

inlineTags

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

Specified by:

inlineTags in interface com.sun.javadoc.Doc

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

isField

public boolean isField()

Specified by:

isField in interface com.sun.javadoc.Doc

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

name

public java.lang.String name()

Specified by:

name in interface com.sun.javadoc.Doc

options

public java.lang.String[][] options()

Specified by:

options in interface com.sun.javadoc.RootDoc

packageNamed

public com.sun.javadoc.PackageDoc packageNamed(java.lang.String arg0)

Specified by:

packageNamed in interface com.sun.javadoc.RootDoc

position

public com.sun.javadoc.SourcePosition position()

Specified by:

position in interface com.sun.javadoc.Doc

printError

public void printError(com.sun.javadoc.SourcePosition arg0,
                       java.lang.String arg1)

Specified by:

printError in interface com.sun.javadoc.DocErrorReporter

printError

public void printError(java.lang.String arg0)

Specified by:

printError in interface com.sun.javadoc.DocErrorReporter

printNotice

public void printNotice(com.sun.javadoc.SourcePosition arg0,
                        java.lang.String arg1)

Specified by:

printNotice in interface com.sun.javadoc.DocErrorReporter

printNotice

public void printNotice(java.lang.String arg0)

Specified by:

printNotice in interface com.sun.javadoc.DocErrorReporter

printWarning

public void printWarning(com.sun.javadoc.SourcePosition arg0,
                         java.lang.String arg1)

Specified by:

printWarning in interface com.sun.javadoc.DocErrorReporter

printWarning

public void printWarning(java.lang.String arg0)

Specified by:

printWarning in interface com.sun.javadoc.DocErrorReporter

seeTags

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

Specified by:

seeTags in interface com.sun.javadoc.Doc

setRawCommentText

public void setRawCommentText(java.lang.String arg0)

Specified by:

setRawCommentText in interface com.sun.javadoc.Doc

specifiedClasses

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

Specified by:

specifiedClasses in interface com.sun.javadoc.RootDoc

specifiedPackages

public com.sun.javadoc.PackageDoc[] specifiedPackages()

Specified by:

specifiedPackages in interface com.sun.javadoc.RootDoc

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