Class ValueTaglet
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseInlineTaglet
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.ValueTaglet
- All Implemented Interfaces:
Taglet
Deprecated.
An inline Taglet representing the value tag. This tag should only be used with
constant fields that have a value. It is used to access the value of constant
fields. This inline tag has an optional field name parameter. If the name is
specified, the constant value is retrieved from the specified field. A link
is also created to the specified field. If a name is not specified, the value
is retrieved for the field that the inline tag appears on. The name is specifed
in the following format: [fully qualified class name]#[constant field name].
This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- Since:
- 1.4
-
Field Summary
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
name
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate FieldDoc
getFieldDoc
(Configuration config, Tag tag, String name) Deprecated.Given the name of the field, return the corresponding FieldDoc.getTagletOutput
(Tag tag, TagletWriter writer) Deprecated.Given theTag
representation of this custom tag, return its Content representation, which is output to the generated page.boolean
Deprecated.Will return false because this inline tag may only appear in Fields.boolean
inMethod()
Deprecated.Will return false because this inline tag may only appear in Fields.boolean
Deprecated.Will return false because this inline tag may only appear in Fields.boolean
Deprecated.Will return false because this inline tag may only appear in Fields.boolean
inType()
Deprecated.Will return false because this inline tag may only appear in Fields.Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseInlineTaglet
isInlineTag
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
getName, getTagletOutput, inField
-
Constructor Details
-
ValueTaglet
public ValueTaglet()Deprecated.Construct a new ValueTaglet.
-
-
Method Details
-
inMethod
public boolean inMethod()Deprecated.Will return false because this inline tag may only appear in Fields.- Specified by:
inMethod
in interfaceTaglet
- Overrides:
inMethod
in classBaseTaglet
- Returns:
- false since this is not a method.
-
inConstructor
public boolean inConstructor()Deprecated.Will return false because this inline tag may only appear in Fields.- Specified by:
inConstructor
in interfaceTaglet
- Overrides:
inConstructor
in classBaseTaglet
- Returns:
- false since this is not a method.
-
inOverview
public boolean inOverview()Deprecated.Will return false because this inline tag may only appear in Fields.- Specified by:
inOverview
in interfaceTaglet
- Overrides:
inOverview
in classBaseTaglet
- Returns:
- false since this is not a method.
-
inPackage
public boolean inPackage()Deprecated.Will return false because this inline tag may only appear in Fields.- Specified by:
inPackage
in interfaceTaglet
- Overrides:
inPackage
in classBaseTaglet
- Returns:
- false since this is not a method.
-
inType
public boolean inType()Deprecated.Will return false because this inline tag may only appear in Fields.- Specified by:
inType
in interfaceTaglet
- Overrides:
inType
in classBaseTaglet
- Returns:
- false since this is not a method.
-
getFieldDoc
Deprecated.Given the name of the field, return the corresponding FieldDoc. Return null due to invalid use of value tag if the name is null or empty string and if the value tag is not used on a field.- Parameters:
config
- the current configuration of the doclet.tag
- the value tag.name
- the name of the field to search for. The name should be in<qualified class name>#<field name>
format. If the class name is omitted, it is assumed that the field is in the current class.- Returns:
- the corresponding FieldDoc. If the name is null or empty string, return field that the value tag was used in. Return null if the name is null or empty string and if the value tag is not used on a field.
-
getTagletOutput
Deprecated.Given theTag
representation of this custom tag, return its Content representation, which is output to the generated page.- Specified by:
getTagletOutput
in interfaceTaglet
- Overrides:
getTagletOutput
in classBaseTaglet
- Parameters:
tag
- theTag
representation of this custom tag.writer
- aTagletWriter
Taglet writer.- Returns:
- the Content representation of this
Tag
.
-