|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjus.util.assertion.AnyTaglet
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 Tag s 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 |
protected java.util.Vector NAMES
protected java.lang.String HEADER
protected boolean[] usableIn
protected static final int inField
protected static final int inConstructor
protected static final int inMethod
protected static final int inOverview
protected static final int inPackage
protected static final int inType
protected boolean isInlineTag
Constructor Detail |
public AnyTaglet()
Method Detail |
public java.util.Iterator iterator()
public java.lang.String getName()
getName
in interface com.sun.tools.doclets.Taglet
public boolean inField()
AnyTaglet
can be used in field documentation.
inField
in interface com.sun.tools.doclets.Taglet
AnyTaglet
can be used in field documentation and false
otherwise.public boolean inConstructor()
AnyTaglet
can be used in constructor documentation.
inConstructor
in interface com.sun.tools.doclets.Taglet
AnyTaglet
can be used in constructor documentation and false
otherwise.public boolean inMethod()
AnyTaglet
can be used in method documentation.
inMethod
in interface com.sun.tools.doclets.Taglet
AnyTaglet
can be used in method documentation and false
otherwise.public boolean inOverview()
AnyTaglet
can be used in method documentation.
inOverview
in interface com.sun.tools.doclets.Taglet
AnyTaglet
can be used in overview documentation and false
otherwise.public boolean inPackage()
AnyTaglet
can be used in package documentation.
inPackage
in interface com.sun.tools.doclets.Taglet
AnyTaglet
can be used in package documentation and false
otherwise.public boolean inType()
AnyTaglet
can be used in type documentation (classes or interfaces).
inType
in interface com.sun.tools.doclets.Taglet
AnyTaglet
can be used in type documentation and false
otherwise.public boolean isInlineTag()
AnyTaglet
is not an inline tag.
isInlineTag
in interface com.sun.tools.doclets.Taglet
AnyTaglet
is not an inline tag.public static void registerTag(java.util.Map tagletMap, com.sun.tools.doclets.Taglet tag)
tagletMap
- the map to register this tag to.public java.lang.String toString(com.sun.javadoc.Tag tag)
Tag
representation of this custom
tag, return its string representation.
toString
in interface com.sun.tools.doclets.Taglet
tag
- he Tag
representation of this custom tag.public java.lang.String toString(com.sun.javadoc.Tag[] tags)
Tag
s representing this custom
tag, return its string representation.
toString
in interface com.sun.tools.doclets.Taglet
tags
- the array of Tag
s representing of this custom tag.protected abstract java.lang.String html(com.sun.javadoc.Tag tag)
Tag
representing this custom
tag, return its string representation.
tag
- the Tag
representing of this custom tag.public java.lang.Object clone()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |