org.objectweb.easybeans.tests.taglets
Class BaseTaglet

java.lang.Object
  extended by org.objectweb.easybeans.tests.taglets.BaseTaglet
All Implemented Interfaces:
com.sun.tools.doclets.Taglet
Direct Known Subclasses:
TagInput, TagOutput, TagReference, TagRequirement, TagSetup

public class BaseTaglet
extends java.lang.Object
implements com.sun.tools.doclets.Taglet

This is a base taglet to document tests. Example: @toto the toto is magic.

Author:
Eduardo Studzinski Estima de Castro, Gisele Pinheiro Souza

Field Summary
private  java.lang.String strName
          Tag literal.
 
Constructor Summary
BaseTaglet(java.lang.String name)
           
 
Method Summary
 java.lang.String getName()
          Return the name of this custom tag.
 boolean inConstructor()
          Will return true.
 boolean inField()
          Will return false.
 boolean inMethod()
          Will return true.
 boolean inOverview()
          Will return true.
 boolean inPackage()
          Will return true.
 boolean inType()
          Will return false.
 boolean isInlineTag()
          Will return false.
 java.lang.String toString(com.sun.javadoc.Tag tag)
          Given the Tag representation of this custom tag,return its string representation.
 java.lang.String toString(com.sun.javadoc.Tag[] tags)
          Given an array of Tags representing this custom tag, return its string representation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

strName

private java.lang.String strName
Tag literal.

Constructor Detail

BaseTaglet

public BaseTaglet(java.lang.String name)
Parameters:
name - tag name. Example: tag = @toto, name = toto.
Method Detail

inField

public boolean inField()
Will return false. The @tagName can't be used in field documentation.

Specified by:
inField in interface com.sun.tools.doclets.Taglet
Returns:
true since @tagName can be used in field documentation and false otherwise.

inConstructor

public boolean inConstructor()
Will return true. The @tagName can be used in constructor documentation.

Specified by:
inConstructor in interface com.sun.tools.doclets.Taglet
Returns:
true since @tagName can be used in constructor documentation and false otherwise.

inMethod

public boolean inMethod()
Will return true. The @tagName can be used in method documentation.

Specified by:
inMethod in interface com.sun.tools.doclets.Taglet
Returns:
true since @tagName can be used in method documentation and false otherwise.

inOverview

public boolean inOverview()
Will return true. The @tagName can be used in overview documentation.

Specified by:
inOverview in interface com.sun.tools.doclets.Taglet
Returns:
true since @tagName can be used in method documentation and false otherwise.

inPackage

public boolean inPackage()
Will return true. The @tagName can be used in package documentation.

Specified by:
inPackage in interface com.sun.tools.doclets.Taglet
Returns:
true since @tagName can be used in method documentation and false otherwise.

inType

public boolean inType()
Will return false. The @tagName can't be used in type documentation.

Specified by:
inType in interface com.sun.tools.doclets.Taglet
Returns:
true since @tagName can be used in type documentation and false otherwise.

isInlineTag

public boolean isInlineTag()
Will return false. The @tagName is not an inline tag.

Specified by:
isInlineTag in interface com.sun.tools.doclets.Taglet
Returns:
false since @tagName is not an inline tag.

getName

public java.lang.String getName()
Return the name of this custom tag.

Specified by:
getName in interface com.sun.tools.doclets.Taglet
Returns:
name

toString

public java.lang.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:
output format of tag text

toString

public java.lang.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.
Returns:
output format of tag texts