jus.util.assertion
Class AnyTaglet

java.lang.Object
  extended byjus.util.assertion.AnyTaglet
All Implemented Interfaces:
java.lang.Cloneable, com.sun.tools.doclets.Taglet
Direct Known Subclasses:
AssertionTaglet, StateTaglet

public abstract class AnyTaglet
extends java.lang.Object
implements com.sun.tools.doclets.Taglet, java.lang.Cloneable


Field Summary
protected  java.lang.String HEADER
           
protected static int inConstructor
           
protected static int inField
           
protected static int inMethod
           
protected static int inOverview
           
protected static int inPackage
           
protected static int inType
           
protected  boolean isInlineTag
           
protected  java.util.Vector NAMES
           
protected  boolean[] usableIn
           
 
Constructor Summary
AnyTaglet()
           
 
Method Summary
 java.lang.Object clone()
          make a clone of this tag
 java.lang.String getName()
          Return the name of this custom tag.
protected abstract  java.lang.String html(com.sun.javadoc.Tag tag)
          Given a Tag representing this custom tag, return its string representation.
 boolean inConstructor()
          Will return true since this AnyTaglet can be used in constructor documentation.
 boolean inField()
          Will return true since this AnyTaglet can be used in field documentation.
 boolean inMethod()
          Will return true since this AnyTaglet can be used in method documentation.
 boolean inOverview()
          Will return true since this AnyTaglet can be used in method documentation.
 boolean inPackage()
          Will return true since this AnyTaglet can be used in package documentation.
 boolean inType()
          Will return true since this AnyTaglet can be used in type documentation (classes or interfaces).
 boolean isInlineTag()
          Will return false since this AnyTaglet is not an inline tag.
 java.util.Iterator iterator()
          Return an iterator over the names for this custom tag
static void registerTag(java.util.Map tagletMap, com.sun.tools.doclets.Taglet tag)
          Register this Taglet.
 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
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAMES

protected java.util.Vector NAMES

HEADER

protected java.lang.String HEADER

usableIn

protected boolean[] usableIn

inField

protected static final int inField
See Also:
Constant Field Values

inConstructor

protected static final int inConstructor
See Also:
Constant Field Values

inMethod

protected static final int inMethod
See Also:
Constant Field Values

inOverview

protected static final int inOverview
See Also:
Constant Field Values

inPackage

protected static final int inPackage
See Also:
Constant Field Values

inType

protected static final int inType
See Also:
Constant Field Values

isInlineTag

protected boolean isInlineTag
Constructor Detail

AnyTaglet

public AnyTaglet()
Method Detail

iterator

public java.util.Iterator iterator()
Return an iterator over the names for this custom tag


getName

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

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

inField

public boolean inField()
Will return true since this AnyTaglet can be used in field documentation.

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

inConstructor

public boolean inConstructor()
Will return true since this AnyTaglet can be used in constructor documentation.

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

inMethod

public boolean inMethod()
Will return true since this AnyTaglet can be used in method documentation.

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

inOverview

public boolean inOverview()
Will return true since this AnyTaglet can be used in method documentation.

Specified by:
inOverview in interface com.sun.tools.doclets.Taglet
Returns:
true since this AnyTaglet can be used in overview documentation and false otherwise.

inPackage

public boolean inPackage()
Will return true since this AnyTaglet can be used in package documentation.

Specified by:
inPackage in interface com.sun.tools.doclets.Taglet
Returns:
true since this AnyTaglet can be used in package documentation and false otherwise.

inType

public boolean inType()
Will return true since this AnyTaglet can be used in type documentation (classes or interfaces).

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

isInlineTag

public boolean isInlineTag()
Will return false since this AnyTaglet is not an inline tag.

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

registerTag

public static void registerTag(java.util.Map tagletMap,
                               com.sun.tools.doclets.Taglet tag)
Register this Taglet.

Parameters:
tagletMap - the map to register this tag to.

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 - he Tag representation of this custom tag.

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.

html

protected abstract java.lang.String html(com.sun.javadoc.Tag tag)
Given a Tag representing this custom tag, return its string representation.

Parameters:
tag - the Tag representing of this custom tag.

clone

public java.lang.Object clone()
make a clone of this tag