org.freehep.tools.doclet.tags
Class SimpleTaglet

java.lang.Object
  org.freehep.tools.doclet.tags.SimpleTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class SimpleTaglet

extends Object

implements com.sun.tools.doclets.Taglet

A simple single argument custom tag used by the Standard Doclet.

Author:

Jamie Ho

Source Code:

SimpleTaglet.java

Field Summary

static String	ALL Use in location string when the tag is to appear in all locations.
static String	CONSTRUCTOR The marker in the location string for constructors.
static String	EXCLUDED The marker in the location string for excluded tags.
static String	FIELD The marker in the location string for fields.
protected String	header The header to output.
protected String	locations The possible locations that this tag can appear in.
static String	METHOD The marker in the location string for methods.
static String	OVERVIEW The marker in the location string for overview.
static String	PACKAGE The marker in the location string for packages.
protected String	tagName The name of this tag.
static String	TYPE The marker in the location string for types.

Constructor Summary

SimpleTaglet(String tagName, String header, String locations)
Construct a SimpleTaglet.

Method Summary

String	getName() Return the name of this Taglet.
boolean	inConstructor() Return true if this SimpleTaglet is used in constructor documentation.
boolean	inField() Return true if this SimpleTaglet is used in field documentation.
boolean	inMethod() Return true if this SimpleTaglet is used in method documentation.
boolean	inOverview() Return true if this SimpleTaglet is used in overview documentation.
boolean	inPackage() Return true if this SimpleTaglet/code> is used in package documentation.
boolean	inType() Return true if this SimpleTaglet is used in type documentation (classes or interfaces).
boolean	isInlineTag() Return true if this Taglet is an inline tag.
String	toString(com.sun.javadoc.Tag tag) Given the Tag representation of this custom tag, return its string representation.
String	toString(com.sun.javadoc.Tag[] tags) Given an array of Tags representing this custom tag, return its string representation.
String	toString(com.sun.javadoc.Tag[] tags, HtmlStandardWriter html) Given an array of Tags representing this custom tag, return its string representation, with inline tags resolved.
String	toString(com.sun.javadoc.Tag tag, HtmlStandardWriter html) Given the Tag representation of this custom tag, return its string representation, with inline tags resolved.

Methods inherited from class java.lang.Object

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

Field Detail

EXCLUDED

public static final String EXCLUDED

The marker in the location string for excluded tags.

See Also:

Constant Field Values

PACKAGE

public static final String PACKAGE

The marker in the location string for packages.

See Also:

Constant Field Values

TYPE

public static final String TYPE

The marker in the location string for types.

See Also:

Constant Field Values

CONSTRUCTOR

public static final String CONSTRUCTOR

The marker in the location string for constructors.

See Also:

Constant Field Values

FIELD

public static final String FIELD

The marker in the location string for fields.

See Also:

Constant Field Values

METHOD

public static final String METHOD

The marker in the location string for methods.

See Also:

Constant Field Values

OVERVIEW

public static final String OVERVIEW

The marker in the location string for overview.

See Also:

Constant Field Values

ALL

public static final String ALL

Use in location string when the tag is to appear in all locations.

See Also:

Constant Field Values

tagName

protected String tagName

The name of this tag.

header

protected String header

The header to output.

locations

protected String locations

The possible locations that this tag can appear in.

Constructor Detail

SimpleTaglet

public SimpleTaglet(String tagName,
                    String header,
                    String locations)

Construct a SimpleTaglet.

Parameters:

tagName - the name of this tag

header - the header to output.

locations - the possible locations that this tag can appear in. The String can contain 'p' for package, 't' for type, 'm' for method, 'c' for constructor and 'f' for field.

Method Detail

getName

public String getName()

Return the name of this Taglet.

Specified by:

getName in interface com.sun.tools.doclets.Taglet

inConstructor

public boolean inConstructor()

Return true if this SimpleTaglet is used in constructor documentation.

Specified by:

inConstructor in interface com.sun.tools.doclets.Taglet

Returns:

true if this SimpleTaglet is used in constructor documentation and false otherwise.

inField

public boolean inField()

Return true if this SimpleTaglet is used in field documentation.

Specified by:

inField in interface com.sun.tools.doclets.Taglet

Returns:

true if this SimpleTaglet is used in field documentation and false otherwise.

inMethod

public boolean inMethod()

Return true if this SimpleTaglet is used in method documentation.

Specified by:

inMethod in interface com.sun.tools.doclets.Taglet

Returns:

true if this SimpleTaglet is used in method documentation and false otherwise.

inOverview

public boolean inOverview()

Return true if this SimpleTaglet is used in overview documentation.

Specified by:

inOverview in interface com.sun.tools.doclets.Taglet

Returns:

true if this SimpleTaglet is used in overview documentation and false otherwise.

inPackage

public boolean inPackage()

Return true if this SimpleTaglet/code> is used in package documentation.

Specified by:

inPackage in interface com.sun.tools.doclets.Taglet

Returns:

true if this SimpleTaglet is used in package documentation and false otherwise.

inType

public boolean inType()

Return true if this SimpleTaglet is used in type documentation (classes or interfaces).

Specified by:

inType in interface com.sun.tools.doclets.Taglet

Returns:

true if this SimpleTaglet is used in type documentation and false otherwise.

isInlineTag

public boolean isInlineTag()

Return true if this Taglet is an inline tag.

Specified by:

isInlineTag in interface com.sun.tools.doclets.Taglet

Returns:

true if this Taglet is an inline tag and false otherwise.

toString

public String toString(com.sun.javadoc.Tag tag)

Given the Tag representation of this custom tag, return its string representation.

Specified by:

toString in interface com.sun.tools.doclets.Taglet

Parameters:

tag - The Tag representation of this custom tag.

toString

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

Given an array of Tags representing this custom tag, return its string representation.

Specified by:

toString in interface com.sun.tools.doclets.Taglet

Parameters:

tags - the array of Tags representing of this custom tag.

toString

public String toString(com.sun.javadoc.Tag tag,
                       HtmlStandardWriter html)

Given the Tag representation of this custom tag, return its string representation, with inline tags resolved.

Parameters:

tag - The Tag representation of this custom tag.

html - The HTMLStandardWriter that will output this tag.

toString

public String toString(com.sun.javadoc.Tag[] tags,
                       HtmlStandardWriter html)

Given an array of Tags representing this custom tag, return its string representation, with inline tags resolved. If there is no output, return null.

Parameters:

tags - The array of Tags representing of this custom tag.

html - The HTMLStandardWriter that will output this tag.