|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.2.0) E17493-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SourceDocTag
A SourceDocTag
represents a block tag within a SourceDocComment
or an in-line tag within a SourceDocDescription
. A tag has a name and zero or more arguments. A tag name includes the leading "@" character, e.g., "@param". The standard tags as of JDK 1.5 are described below, grouped by the number and types of the children.
The children of a doc tag vary with the tag type, as described below. For unrecognized tags, any arguments are collected in a description.
No-Argument Tags
{@docRoot}
{@inheritDoc}
{@value}
Children
One-Argument Tags
Children
SourceDocTagName
(see SourceHasName.getNameElement()
)SourceDocDescription
(see SourceDocHasDescription.getDescription()
)
Two-Argument Exception Tags
Children
SourceDocTagName
(see SourceHasName.getNameElement()
)SourceDocReference
(see getReference()
)SourceDocDescription
(see SourceDocHasDescription.getDescription()
)
Two-Argument Parameter Tag
Children
SourceDocTagName
(see SourceHasName.getNameElement()
)SourceDocReference
(see getReference()
)SourceDocDescription
(see SourceDocHasDescription.getDescription()
)
Two-Argument Reference Tags
Children
SourceDocTagName
(see SourceHasName.getNameElement()
)SourceDocReference
(see getReference()
)SourceDocDescription
(see SourceDocHasDescription.getDescription()
)
Three-Argument Tags
Children
SourceDocTagName
(see SourceHasName.getNameElement()
)SourceDocReference
(see getFieldNameReference()
)SourceDocReference
(see getFieldTypeReference()
)SourceDocDescription
(see SourceDocHasDescription.getDescription()
)Field Summary |
---|
Fields inherited from interface oracle.javatools.parser.java.v2.model.SourceElement |
---|
CHILDREN_ALL, CHILDREN_BLANKLINES, CHILDREN_COMMENTS, CHILDREN_default, CHILDREN_none, CHILDREN_REGULAR, EMPTY_ARRAY, PRINT_ALL, REFORMAT_ALL, REFORMAT_INDENT |
Method Summary | |
---|---|
java.lang.String |
getArgumentText() Gets the argument text of this documentation tag. |
SourceDocReference |
getFieldNameReference() Gets the field name reference argument of this tag, or null if this is not a @serialField tag. |
SourceDocReference |
getFieldTypeReference() Gets the field type refernce argument of this tag, or null if this is not a @serialField tag. |
SourceDocReference |
getReference() Gets the reference argument of this tag, or null if this is not an @exception , @link , @linkplain , @param , @see , @throws , or two-argument @value tag. |
java.lang.String |
getReferenceText() Gets the normalized text of the reference argument of this tag, or null if this is not an @exception , @link , @linkplain , @param , @see , @throws , or two-argument @value tag. |
boolean |
isBlock() Gets whether this tag is a block tag. |
boolean |
isException() Gets whether this tag is an @exception or @throws tag. |
boolean |
isInline() Gets whether this tag is an in-line tag. |
boolean |
isParameter() Gets whether this tag is a @param tag. |
boolean |
isReference() Gets whether this tag is a @link , @linkplain , @see , or two-argument @value tag. |
boolean |
isSerial() Gets whether this tag is a @serial or @serialData tag. |
boolean |
isSerialField() Gets whether this tag is a @serialField tag. |
boolean |
isStandard() Gets whether this tag is a standard tag. |
Methods inherited from interface oracle.javatools.parser.java.v2.model.doc.SourceDocHasDescription |
---|
getDescription, setDescription |
Methods inherited from interface oracle.javatools.parser.java.v2.model.doc.SourceDocElement |
---|
getDocText, getInlineTags, getOwningDocComment, getOwningMember, getReferences, isBlank |
Methods inherited from interface oracle.javatools.parser.java.v2.model.SourceElement |
---|
addSelf, addSelf, addSelfAfter, addSelfBefore, adjustTextIndentation, clearBinding, cloneSelf, compile, getBinding, getChildren, getChildren, getCompiledObject, getContainedElements, getEndOffset, getOwningFile, getOwningSourceFile, getParent, getSiblingAfter, getSiblingBefore, getSiblings, getSiblings, getStartOffset, getSymbolKind, getText, hasErrors, print, print, reformatSelf, removeSelf, replaceSelf, resolve, setBinding, setContext, visitSelf |
Methods inherited from interface oracle.javatools.parser.java.v2.model.SourceHasName |
---|
getName, getNameElement, setName, setNameElement |
Method Detail |
---|
java.lang.String getArgumentText()
SourceDocReference getReference()
@exception
, @link
, @linkplain
, @param
, @see
, @throws
, or two-argument @value
tag.isException()
, isParameter()
, isReference()
java.lang.String getReferenceText()
@exception
, @link
, @linkplain
, @param
, @see
, @throws
, or two-argument @value
tag.isException()
, isParameter()
, isReference()
, SourceDocReference.getNormalizedText()
boolean isBlock()
SourceDocBlockTag
boolean isInline()
SourceDocInlineTag
boolean isStandard()
class overview
, false otherwise.boolean isException()
@exception
or @throws
tag.@exception
or @throws
tag, false otherwise.getReference()
boolean isParameter()
@param
tag.@param
tag, false otherwise.getReference()
boolean isReference()
@link
, @linkplain
, @see
, or two-argument @value
tag. Gets false for the @see
"string" and @see
variants.@link
, @linkplain
, @see
, or two-argument @value
tag, false otherwise.getReference()
boolean isSerial()
@serial
or @serialData
tag.@serial
or @serialData
tag, false otherwise.boolean isSerialField()
@serialField
tag.getFieldNameReference()
, getFieldTypeReference()
SourceDocReference getFieldNameReference()
@serialField
tag.isSerialField()
SourceDocReference getFieldTypeReference()
@serialField
tag.isSerialField()
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.2.0) E17493-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |