org.freehep.tools.doclet
Class TagletManager

java.lang.Object
  org.freehep.tools.doclet.TagletManager

public class TagletManager

extends Object

Manages theTaglets used by doclets.

Since:

JDK 1.4

Author:

Jamie Ho

Source Code:

TagletManager.java

Field Summary

static String	ALT_SIMPLE_TAGLET_OPT_SEPERATOR The alternate seperator for simple tag options.
static String	SIMPLE_TAGLET_OPT_SEPERATOR The default seperator for the simple tag option.

Constructor Summary

TagletManager(boolean nosince, boolean showversion, boolean showauthor, com.sun.tools.doclets.MessageRetriever message)
Construct a new TagletManager.

Method Summary

void	addCustomTag(String classname, String tagletPath) Add a new Taglet.
void	addCustomTag(com.sun.tools.doclets.Taglet customTag) Add a new CustomTag.
void	addNewSimpleCustomTag(String tagName, String header, String locations) Add a new SimpleTaglet.
void	checkTags(com.sun.javadoc.Doc doc, com.sun.javadoc.Tag[] tags, boolean areInlineTags) Given an array of Tags, check for spelling mistakes.
com.sun.tools.doclets.Taglet[]	getConstructorCustomTags() Return the array of Taglets that can appear in constructors.
com.sun.tools.doclets.Taglet[]	getFieldCustomTags() Return the array of Taglets that can appear in fields.
com.sun.tools.doclets.Taglet[]	getInlineCustomTags() Return the array of inline Taglets that can appear in comments.
com.sun.tools.doclets.Taglet[]	getMethodCustomTags() Return the array of Taglets that can appear in methods.
com.sun.tools.doclets.Taglet[]	getOverviewCustomTags() Return the array of Taglets that can appear in an overview.
com.sun.tools.doclets.Taglet[]	getPackageCustomTags() Return the array of Taglets that can appear in packages.
com.sun.tools.doclets.Taglet[]	getTypeCustomTags() Return the array of Taglets that can appear in classes or interfaces.
boolean	isKnownCustomTag(String tagName)
void	printReport() Print a list of Taglets that might conflict with standard tags in the future and a list of standard tags that have been overriden.
void	seenCustomTag(String name) Given a name of a seen custom tag, remove it from the set of unseen custom tags.

Methods inherited from class java.lang.Object

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

Field Detail

SIMPLE_TAGLET_OPT_SEPERATOR

public static final String SIMPLE_TAGLET_OPT_SEPERATOR

The default seperator for the simple tag option.

See Also:

Constant Field Values

ALT_SIMPLE_TAGLET_OPT_SEPERATOR

public static final String ALT_SIMPLE_TAGLET_OPT_SEPERATOR

The alternate seperator for simple tag options. Use this with you want the default seperator to be in the name of the custom tag.

See Also:

Constant Field Values

Constructor Detail

TagletManager

public TagletManager(boolean nosince,
                     boolean showversion,
                     boolean showauthor,
                     com.sun.tools.doclets.MessageRetriever message)

Construct a new TagletManager.

Parameters:

nosince - true if we do not want to use @since tags.

showversion - true if we want to use @version tags.

showauthor - true if we want to use @author tags.

message - the message retriever to print warnings.

Method Detail

addCustomTag

public void addCustomTag(com.sun.tools.doclets.Taglet customTag)

Add a new CustomTag. This is used to add a Taglet from within a Doclet. No message is printed to indicate that the Taglet is properly registered because these Taglets are typically added for every execution of the Doclet. We don't want to see this type of error message every time.

Parameters:

customTag - the new CustomTag to add.

addCustomTag

public void addCustomTag(String classname,
                         String tagletPath)

Add a new Taglet. Print a message to indicate whether or not the Taglet was registered properly.

Parameters:

classname - the name of the class representing the custom tag.

tagletPath - the path to the class representing the custom tag.

addNewSimpleCustomTag

public void addNewSimpleCustomTag(String tagName,
                                  String header,
                                  String locations)

Add a new SimpleTaglet. If this tag already exists and the header passed as an argument is null, move tag to the back of the list. If this tag already exists and the header passed as an argument is not null, overwrite previous tag with new one. Otherwise, add new SimpleTaglet to list.

Parameters:

tagName - the name of this tag

header - the header to output.

locations - the possible locations that this tag can appear in.

seenCustomTag

public void seenCustomTag(String name)

Given a name of a seen custom tag, remove it from the set of unseen custom tags.

Parameters:

name - the name of the seen custom tag.

checkTags

public void checkTags(com.sun.javadoc.Doc doc,
                      com.sun.javadoc.Tag[] tags,
                      boolean areInlineTags)

Given an array of Tags, check for spelling mistakes.

Parameters:

doc - the Doc object that holds the tags.

tags - the list of Tags to check.

areInlineTags - true if the array of tags are inline and false otherwise.

getPackageCustomTags

public com.sun.tools.doclets.Taglet[] getPackageCustomTags()

Return the array of Taglets that can appear in packages.

Returns:

the array of Taglets that can appear in packages.

getTypeCustomTags

public com.sun.tools.doclets.Taglet[] getTypeCustomTags()

Return the array of Taglets that can appear in classes or interfaces.

Returns:

the array of Taglets that can appear in classes or interfaces.

getInlineCustomTags

public com.sun.tools.doclets.Taglet[] getInlineCustomTags()

Return the array of inline Taglets that can appear in comments.

Returns:

the array of Taglets that can appear in comments.

getFieldCustomTags

public com.sun.tools.doclets.Taglet[] getFieldCustomTags()

Return the array of Taglets that can appear in fields.

Returns:

the array of Taglets that can appear in field.

getConstructorCustomTags

public com.sun.tools.doclets.Taglet[] getConstructorCustomTags()

Return the array of Taglets that can appear in constructors.

Returns:

the array of Taglets that can appear in constructors.

getMethodCustomTags

public com.sun.tools.doclets.Taglet[] getMethodCustomTags()

Return the array of Taglets that can appear in methods.

Returns:

the array of Taglets that can appear in methods.

getOverviewCustomTags

public com.sun.tools.doclets.Taglet[] getOverviewCustomTags()

Return the array of Taglets that can appear in an overview.

Returns:

the array of Taglets that can appear in overview.

isKnownCustomTag

public boolean isKnownCustomTag(String tagName)

printReport

public void printReport()

Print a list of Taglets that might conflict with standard tags in the future and a list of standard tags that have been overriden.