org.jdrupes.mdoclet

Class RootDocWrapper

java.lang.Object

org.jdrupes.mdoclet.RootDocWrapper

All Implemented Interfaces:

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

public class RootDocWrapper
extends Object
implements com.sun.javadoc.RootDoc

A wrapper for the RootDoc. It forwards all calls to the original root document exception options(), which may contain a modified array of doclet options.

Constructor Summary

Constructors

Constructor and Description
RootDocWrapper(com.sun.javadoc.RootDoc delegate, String[][] options)

Method Summary

Modifier and Type	Method and Description
void	appendOption(String... option) Append an option to the doclet options.
com.sun.javadoc.ClassDoc[]	classes()
com.sun.javadoc.ClassDoc	classNamed(String qualifiedName)
String	commentText()
int	compareTo(Object obj)
String[]	findOption(String option) Looks for the given option and returns it, if it exists.
com.sun.javadoc.Tag[]	firstSentenceTags()
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()
String	name()
String[][]	options() Overriden to return a modified array of doclet options.
com.sun.javadoc.PackageDoc	packageNamed(String name)
com.sun.javadoc.SourcePosition	position()
void	printError(com.sun.javadoc.SourcePosition pos, String msg)
void	printError(String msg)
void	printNotice(com.sun.javadoc.SourcePosition pos, String msg)
void	printNotice(String msg)
void	printWarning(com.sun.javadoc.SourcePosition pos, String msg)
void	printWarning(String msg)
com.sun.javadoc.SeeTag[]	seeTags()
void	setRawCommentText(String rawDocumentation)
com.sun.javadoc.ClassDoc[]	specifiedClasses()
com.sun.javadoc.PackageDoc[]	specifiedPackages()
com.sun.javadoc.Tag[]	tags()
com.sun.javadoc.Tag[]	tags(String tagname)

Methods inherited from class java.lang.Object

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

Constructor Detail

RootDocWrapper

public RootDocWrapper(com.sun.javadoc.RootDoc delegate,
                      String[][] options)

Method Detail

findOption

public String[] findOption(String option)

Looks for the given option and returns it, if it exists.

Returns:

the option or null

appendOption

public void appendOption(String... option)

Append an option to the doclet options.

Parameters:

option - The option to append.

options

public String[][] options()

Overriden to return a modified array of doclet options.

Specified by:

options in interface com.sun.javadoc.RootDoc

Returns:

The modified doclet options.

specifiedPackages

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

Specified by:

specifiedPackages in interface com.sun.javadoc.RootDoc

specifiedClasses

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

Specified by:

specifiedClasses in interface com.sun.javadoc.RootDoc

classes

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

Specified by:

classes in interface com.sun.javadoc.RootDoc

packageNamed

public com.sun.javadoc.PackageDoc packageNamed(String name)

Specified by:

packageNamed in interface com.sun.javadoc.RootDoc

classNamed

public com.sun.javadoc.ClassDoc classNamed(String qualifiedName)

Specified by:

classNamed in interface com.sun.javadoc.RootDoc

commentText

public String commentText()

Specified by:

commentText in interface com.sun.javadoc.Doc

tags

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

Specified by:

tags in interface com.sun.javadoc.Doc

tags

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

Specified by:

tags in interface com.sun.javadoc.Doc

seeTags

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

Specified by:

seeTags in interface com.sun.javadoc.Doc

inlineTags

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

Specified by:

inlineTags in interface com.sun.javadoc.Doc

firstSentenceTags

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

Specified by:

firstSentenceTags in interface com.sun.javadoc.Doc

getRawCommentText

public String getRawCommentText()

Specified by:

getRawCommentText in interface com.sun.javadoc.Doc

setRawCommentText

public void setRawCommentText(String rawDocumentation)

Specified by:

setRawCommentText in interface com.sun.javadoc.Doc

name

public String name()

Specified by:

name in interface com.sun.javadoc.Doc

compareTo

public int compareTo(Object obj)

Specified by:

compareTo in interface com.sun.javadoc.Doc

Specified by:

compareTo in interface Comparable<Object>

isField

public boolean isField()

Specified by:

isField in interface com.sun.javadoc.Doc

isEnumConstant

public boolean isEnumConstant()

Specified by:

isEnumConstant in interface com.sun.javadoc.Doc

isConstructor

public boolean isConstructor()

Specified by:

isConstructor in interface com.sun.javadoc.Doc

isMethod

public boolean isMethod()

Specified by:

isMethod in interface com.sun.javadoc.Doc

isAnnotationTypeElement

public boolean isAnnotationTypeElement()

Specified by:

isAnnotationTypeElement in interface com.sun.javadoc.Doc

isInterface

public boolean isInterface()

Specified by:

isInterface in interface com.sun.javadoc.Doc

isException

public boolean isException()

Specified by:

isException in interface com.sun.javadoc.Doc

isError

public boolean isError()

Specified by:

isError in interface com.sun.javadoc.Doc

isEnum

public boolean isEnum()

Specified by:

isEnum in interface com.sun.javadoc.Doc

isAnnotationType

public boolean isAnnotationType()

Specified by:

isAnnotationType in interface com.sun.javadoc.Doc

isOrdinaryClass

public boolean isOrdinaryClass()

Specified by:

isOrdinaryClass in interface com.sun.javadoc.Doc

isClass

public boolean isClass()

Specified by:

isClass in interface com.sun.javadoc.Doc

isIncluded

public boolean isIncluded()

Specified by:

isIncluded in interface com.sun.javadoc.Doc

position

public com.sun.javadoc.SourcePosition position()

Specified by:

position in interface com.sun.javadoc.Doc

printError

public void printError(String msg)

Specified by:

printError in interface com.sun.javadoc.DocErrorReporter

printError

public void printError(com.sun.javadoc.SourcePosition pos,
                       String msg)

Specified by:

printError in interface com.sun.javadoc.DocErrorReporter

printWarning

public void printWarning(String msg)

Specified by:

printWarning in interface com.sun.javadoc.DocErrorReporter

printWarning

public void printWarning(com.sun.javadoc.SourcePosition pos,
                         String msg)

Specified by:

printWarning in interface com.sun.javadoc.DocErrorReporter

printNotice

public void printNotice(String msg)

Specified by:

printNotice in interface com.sun.javadoc.DocErrorReporter

printNotice

public void printNotice(com.sun.javadoc.SourcePosition pos,
                        String msg)

Specified by:

printNotice in interface com.sun.javadoc.DocErrorReporter