org.opengis.tools.taglet
Class Note

Show UML class diagram

Object
  Note

All Implemented Interfaces:

Taglet

public final class Note
extends Object
implements Taglet

The @note tag for inserting a note in a javadoc comment.

Since:

2.0

Method Summary

String	getName() Returns the name of this custom tag.
boolean	inConstructor() Returns true since @note can be used in constructor
boolean	inField() Returns true since @note can be used in field documentation.
boolean	inMethod() Returns true since @note can be used in method documentation.
boolean	inOverview() Returns true since @note can be used in overview.
boolean	inPackage() Returns true since @note can be used in package documentation.
boolean	inType() Returns true since @note can be used in type documentation (classes or interfaces).
boolean	isInlineTag() Returns true since @note is an inline tag.
static void	register(Map<String,Taglet> tagletMap) Register this taglet.
String	toString(Tag tag) Given the Tag representation of this custom tag, return its string representation.
String	toString(Tag[] tags) Given an array of Tags representing this custom tag, return its string representation.

Methods inherited from class Object

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

Method Detail

register

public static void register(Map<String,Taglet> tagletMap)

Register this taglet.

Parameters:

tagletMap - the map to register this tag to.

getName

public String getName()

Returns the name of this custom tag.

Specified by:

getName in interface Taglet

Returns:

The tag name.

inOverview

public boolean inOverview()

Returns true since @note can be used in overview.

Specified by:

inOverview in interface Taglet

Returns:

Always true.

inPackage

public boolean inPackage()

Returns true since @note can be used in package documentation.

Specified by:

inPackage in interface Taglet

Returns:

Always true.

inType

public boolean inType()

Returns true since @note can be used in type documentation (classes or interfaces).

Specified by:

inType in interface Taglet

Returns:

Always true.

inConstructor

public boolean inConstructor()

Returns true since @note can be used in constructor

Specified by:

inConstructor in interface Taglet

Returns:

Always true.

inMethod

public boolean inMethod()

Returns true since @note can be used in method documentation.

Specified by:

inMethod in interface Taglet

Returns:

Always true.

inField

public boolean inField()

Returns true since @note can be used in field documentation.

Specified by:

inField in interface Taglet

Returns:

Always true.

isInlineTag

public boolean isInlineTag()

Returns true since @note is an inline tag.

Specified by:

isInlineTag in interface Taglet

Returns:

Always true.

toString

public String toString(Tag tag)

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

Specified by:

toString in interface Taglet

Parameters:

tag - The tag to format.

Returns:

A string representation of the given tag.

toString

public String toString(Tag[] tags)

Given an array of Tags representing this custom tag, return its string representation. This method should not be called since arrays of inline tags do not exist. However we define it as a matter of principle.

Specified by:

toString in interface Taglet

Parameters:

tags - The tags to format.

Returns:

A string representation of the given tags.