Class BasePropertyTaglet
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BasePropertyTaglet
- All Implemented Interfaces:
Taglet
- Direct Known Subclasses:
PropertyGetterTaglet
,PropertySetterTaglet
Deprecated.
An abstract class that implements the
Taglet
interface and
serves as a base for JavaFX property getter and setter taglets.
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.
-
Field Summary
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
name
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetTagletOutput
(Tag tag, TagletWriter tagletWriter) Deprecated.Given theTag
representation of this custom tag, return its string representation, which is output to the generated page.(package private) abstract String
getText
(TagletWriter tagletWriter) Deprecated.This method returns the text to be put in the resulting javadoc before the property name.boolean
Deprecated.Will return false because this tag may only appear in Methods.boolean
Deprecated.Will return false because this tag may only appear in Methods.boolean
Deprecated.Will return false because this tag may only appear in Methods.boolean
inType()
Deprecated.Will return false because this tag may only appear in Methods.boolean
Deprecated.Will return false because this tag is not inline.Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
getName, getTagletOutput, inField, inMethod
-
Constructor Details
-
BasePropertyTaglet
public BasePropertyTaglet()Deprecated.
-
-
Method Details
-
getText
Deprecated.This method returns the text to be put in the resulting javadoc before the property name.- Parameters:
tagletWriter
- the taglet writer for output- Returns:
- the string to be put in the resulting javadoc.
-
getTagletOutput
Deprecated.Given theTag
representation of this custom tag, return its string 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.tagletWriter
- the taglet writer for output.- Returns:
- the TagletOutput representation of this
Tag
.
-
inConstructor
public boolean inConstructor()Deprecated.Will return false because this tag may only appear in Methods.- 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 tag may only appear in Methods.- 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 tag may only appear in Methods.- 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 tag may only appear in Methods.- Specified by:
inType
in interfaceTaglet
- Overrides:
inType
in classBaseTaglet
- Returns:
- false since this is not a method.
-
isInlineTag
public boolean isInlineTag()Deprecated.Will return false because this tag is not inline.- Specified by:
isInlineTag
in interfaceTaglet
- Overrides:
isInlineTag
in classBaseTaglet
- Returns:
- false since this is not an inline tag.
-