net.sf.anupam.csv.taglets
Class CSVFieldMappingTaglet

java.lang.Object
  net.sf.anupam.csv.taglets.CSVFieldMappingTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class CSVFieldMappingTaglet
extends Object
implements com.sun.tools.doclets.Taglet

Taglet for outputting the field mapping tag information. The @csv.field-mapping tags will be displayed for classes that have CSV field mapping set in the method Javadoc documentation. The tag can only be used on the mapped bean's getXXX() method Javadocs.

Since:

1.5

Version:

$Revision: 1.2 $

Author:

Anupam Sengupta

Constructor Summary

CSVFieldMappingTaglet()
Constructor for CSVBeanMappingTaglet.

Method Summary

String	getName() Returns the name of this Javadoc tag.
boolean	inConstructor() Indicates whether this tag can be used in a constructor Javadoc.
boolean	inField() Indicates whether this tag can be used in a field Javadoc.
boolean	inMethod() Indicates whether this tag can be used in a method Javadoc.
boolean	inOverview() Indicates whether this tag can be used in the overview Javadoc.
boolean	inPackage() Indicates whether this tag can be used in the package Javadoc.
boolean	inType() Indicates whether this tag can be used in a type Javadoc.
boolean	isInlineTag() Indicates whether this is an inline tag.
static void	register(Map<String,com.sun.tools.doclets.internal.toolkit.taglets.Taglet> tagletMap) Register a new instance of this taglet to the Javadoc taglet set.
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) Returns the string to be included the the output Javadoc for the specified tags.

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVFieldMappingTaglet

public CSVFieldMappingTaglet()

Constructor for CSVBeanMappingTaglet.

Method Detail

getName

public String getName()

Returns the name of this Javadoc tag.

Specified by:

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

Returns:

the name of this tag

See Also:

Taglet.getName()

inConstructor

public boolean inConstructor()

Indicates whether this tag can be used in a constructor Javadoc.

Specified by:

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

Returns:

false

See Also:

Taglet.inConstructor()

inField

public boolean inField()

Indicates whether this tag can be used in a field Javadoc.

Specified by:

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

Returns:

false

See Also:

Taglet.inField()

inMethod

public boolean inMethod()

Indicates whether this tag can be used in a method Javadoc.

Specified by:

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

Returns:

true

See Also:

Taglet.inMethod()

inOverview

public boolean inOverview()

Indicates whether this tag can be used in the overview Javadoc.

Specified by:

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

Returns:

false

See Also:

Taglet.inOverview()

inPackage

public boolean inPackage()

Indicates whether this tag can be used in the package Javadoc.

Specified by:

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

Returns:

false

See Also:

Taglet.inPackage()

inType

public boolean inType()

Indicates whether this tag can be used in a type Javadoc.

Specified by:

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

Returns:

false

See Also:

Taglet.inType()

isInlineTag

public boolean isInlineTag()

Indicates whether this is an inline tag.

Specified by:

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

Returns:

false

See Also:

Taglet.isInlineTag()

register

public static void register(Map<String,com.sun.tools.doclets.internal.toolkit.taglets.Taglet> tagletMap)

Register a new instance of this taglet to the Javadoc taglet set.

Parameters:

tagletMap - the Javadoc taglet set.

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.

Returns:

String representation of the tag

toString

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

Returns the string to be included the the output Javadoc for the specified tags.

Specified by:

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

Parameters:

tags - the tags for which the string representation should be returned

Returns:

the string representation to include in the output Javadoc

See Also:

Taglet.toString(com.sun.javadoc.Tag[])