org.umlgraph.doclet

Class WrappedRootDoc

java.lang.Object

org.umlgraph.doclet.WrappedRootDoc

All Implemented Interfaces:

Doc, DocErrorReporter, RootDoc, Comparable<Object>

public class WrappedRootDoc
extends Object
implements 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) RootDoc	wrapped
(package private) WrappedClassDoc[]	wrappedClassDocs

Constructor Summary

Constructors

Constructor and Description
WrappedRootDoc(RootDoc wrapped)

Method Summary

Methods

Modifier and Type	Method and Description
ClassDoc[]	classes()
ClassDoc	classNamed(String arg0)
String	commentText()
int	compareTo(Object arg0)
Tag[]	firstSentenceTags()
String	getRawCommentText()
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()
String	name()
String[][]	options()
PackageDoc	packageNamed(String arg0)
SourcePosition	position()
void	printError(SourcePosition arg0, String arg1)
void	printError(String arg0)
void	printNotice(SourcePosition arg0, String arg1)
void	printNotice(String arg0)
void	printWarning(SourcePosition arg0, String arg1)
void	printWarning(String arg0)
SeeTag[]	seeTags()
void	setRawCommentText(String arg0)
ClassDoc[]	specifiedClasses()
PackageDoc[]	specifiedPackages()
Tag[]	tags()
Tag[]	tags(String arg0)

Methods inherited from class java.lang.Object

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

Field Detail

wrapped

RootDoc wrapped

wrappedClassDocs

WrappedClassDoc[] wrappedClassDocs

Constructor Detail

WrappedRootDoc

public WrappedRootDoc(RootDoc wrapped)

Method Detail

classes

public ClassDoc[] classes()

Specified by:

classes in interface RootDoc

classNamed

public ClassDoc classNamed(String arg0)

Specified by:

classNamed in interface RootDoc

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>

firstSentenceTags

public Tag[] firstSentenceTags()

Specified by:

firstSentenceTags in interface Doc

getRawCommentText

public String getRawCommentText()

Specified by:

getRawCommentText in interface Doc

inlineTags

public Tag[] inlineTags()

Specified by:

inlineTags in interface Doc

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

isField

public boolean isField()

Specified by:

isField in interface Doc

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

name

public String name()

Specified by:

name in interface Doc

options

public String[][] options()

Specified by:

options in interface RootDoc

packageNamed

public PackageDoc packageNamed(String arg0)

Specified by:

packageNamed in interface RootDoc

position

public SourcePosition position()

Specified by:

position in interface Doc

printError

public void printError(SourcePosition arg0,
              String arg1)

Specified by:

printError in interface DocErrorReporter

printError

public void printError(String arg0)

Specified by:

printError in interface DocErrorReporter

printNotice

public void printNotice(SourcePosition arg0,
               String arg1)

Specified by:

printNotice in interface DocErrorReporter

printNotice

public void printNotice(String arg0)

Specified by:

printNotice in interface DocErrorReporter

printWarning

public void printWarning(SourcePosition arg0,
                String arg1)

Specified by:

printWarning in interface DocErrorReporter

printWarning

public void printWarning(String arg0)

Specified by:

printWarning in interface DocErrorReporter

seeTags

public SeeTag[] seeTags()

Specified by:

seeTags in interface Doc

setRawCommentText

public void setRawCommentText(String arg0)

Specified by:

setRawCommentText in interface Doc

specifiedClasses

public ClassDoc[] specifiedClasses()

Specified by:

specifiedClasses in interface RootDoc

specifiedPackages

public PackageDoc[] specifiedPackages()

Specified by:

specifiedPackages in interface RootDoc

tags

public Tag[] tags()

Specified by:

tags in interface Doc

tags

public Tag[] tags(String arg0)

Specified by:

tags in interface Doc