Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.1.0)

E17493-02

oracle.javatools.parser.java.v2.model.doc
Interface SourceDocTag

All Superinterfaces:
Element, SourceDocElement, SourceDocHasDescription, SourceElement, SourceHasName
All Known Subinterfaces:
SourceDocBlockTag, SourceDocInlineTag

public interface SourceDocTag
extends SourceDocHasDescription, SourceHasName

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

Children
One-Argument Tags Children
Two-Argument Exception Tags Children
Two-Argument Parameter Tag Children
Two-Argument Reference Tags
  • {@link package.class#member label}
  • {@linkplain package.class#member label}
  • @see package.class#member label
  • {@value package.class#member label}
  • Children
    Three-Argument Tags Children


    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

    getArgumentText

    java.lang.String getArgumentText()
    Gets the argument text of this documentation tag. For a block tag, this is the text after the name and before the tag name of the next block tag; for an in-line tag, this is the text after the name and before the closing brace.


    getReference

    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.

    See Also:
    isException(), isParameter(), isReference()

    getReferenceText

    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.

    Returns:
    The text of the reference argument. Null if this tag may not have a reference argument. Empty if this tag may have a reference argument but there is none.
    See Also:
    isException(), isParameter(), isReference(), SourceDocReference.getNormalizedText()

    isBlock

    boolean isBlock()
    Gets whether this tag is a block tag.

    Returns:
    true if this tag is a block tag, false if this tag is an in-line tag.
    See Also:
    SourceDocBlockTag

    isInline

    boolean isInline()
    Gets whether this tag is an in-line tag.

    Returns:
    true if this tag is an in-line tag, false if this tag is a block tag.
    See Also:
    SourceDocInlineTag

    isStandard

    boolean isStandard()
    Gets whether this tag is a standard tag.

    Returns:
    true if the tag name is one of the standard tags listed in the class overview, false otherwise.

    isException

    boolean isException()
    Gets whether this tag is an @exception or @throws tag.

    Returns:
    true if this tag is an @exception or @throws tag, false otherwise.
    See Also:
    getReference()

    isParameter

    boolean isParameter()
    Gets whether this tag is a @param tag.

    Returns:
    true if this tag is a @param tag, false otherwise.
    See Also:
    getReference()

    isReference

    boolean isReference()
    Gets whether this tag is a @link, @linkplain, @see, or two-argument @value tag. Gets false for the @see "string" and @see variants.

    Returns:
    true if this tag is a @link, @linkplain, @see, or two-argument @value tag, false otherwise.
    See Also:
    getReference()

    isSerial

    boolean isSerial()
    Gets whether this tag is a @serial or @serialData tag.

    Returns:
    true if this tag is @serial or @serialData tag, false otherwise.

    isSerialField

    boolean isSerialField()
    Gets whether this tag is a @serialField tag.

    See Also:
    getFieldNameReference(), getFieldTypeReference()

    getFieldNameReference

    SourceDocReference getFieldNameReference()
    Gets the field name reference argument of this tag, or null if this is not a @serialField tag.

    See Also:
    isSerialField()

    getFieldTypeReference

    SourceDocReference getFieldTypeReference()
    Gets the field type refernce argument of this tag, or null if this is not a @serialField tag.

    See Also:
    isSerialField()

    Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
    11g Release 2 (11.1.2.1.0)

    E17493-02

    Copyright © 1997, 2011, Oracle. All rights reserved.