Package gw.gosudoc.com.sun.tools.javadoc.main

Class TagImpl

  • All Implemented Interfaces:
    Tag
    Direct Known Subclasses:
    ParamTagImpl, SeeTagImpl, SerialFieldTagImpl, ThrowsTagImpl
    @Deprecated
class TagImpl
extends java.lang.Object
implements Tag
    Deprecated.
    Represents a documentation tag, e.g. @since, @author, @version. Given a tag (e.g. "@since 1.2"), holds tag name (e.g. "@since") and tag text (e.g. "1.2"). TagImpls with structure or which require special processing are handled by subclasses (ParamTagImpl, SeeTagImpl, and ThrowsTagImpl

    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.

    See Also:
    SeeTagImpl, ParamTagImpl, ThrowsTagImpl, Doc.tags()

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private Tag[] firstSentence
      Deprecated.
      Cached first sentence.
      protected DocImpl holder
      Deprecated.
       
      private Tag[] inlineTags
      Deprecated.
      Cached inline tags.
      protected java.lang.String name
      Deprecated.
       
      protected java.lang.String text
      Deprecated.
       

    • Constructor Summary

      Constructors 
      Constructor Description
      TagImpl​(DocImpl holder, java.lang.String name, java.lang.String text)
      Deprecated.
      Constructor

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      (package private) java.lang.String[] divideAtWhite()
      Deprecated.
      for use by subclasses which have two part tag text.
      (package private) DocEnv docenv()
      Deprecated.
       
      Tag[] firstSentenceTags()
      Deprecated.
      Return array of tags for the first sentence in the doc comment text.
      Doc holder()
      Deprecated.
      Return the containing Doc of this Tag element.
      Tag[] inlineTags()
      Deprecated.
      For documentation comment with embedded @link tags, return the array of TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s).
      java.lang.String kind()
      Deprecated.
      Return the kind of this tag.
      java.lang.String name()
      Deprecated.
      Return the name of this tag.
      SourcePosition position()
      Deprecated.
      Return the doc item to which this tag is attached.
      java.lang.String text()
      Deprecated.
      Return the text of this tag, that is, portion beyond tag name.
      java.lang.String toString()
      Deprecated.
      convert this object to a string.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • text

        protected final java.lang.String text
        Deprecated.

      • name

        protected final java.lang.String name
        Deprecated.

      • holder

        protected final DocImpl holder
        Deprecated.

      • firstSentence

        private Tag[] firstSentence
        Deprecated.
        Cached first sentence.

      • inlineTags

        private Tag[] inlineTags
        Deprecated.
        Cached inline tags.

    • Constructor Detail

      • TagImpl

        TagImpl​(DocImpl holder,
        java.lang.String name,
        java.lang.String text)
        Deprecated.
        Constructor

    • Method Detail

      • name

        public java.lang.String name()
        Deprecated.
        Return the name of this tag.
        Specified by:
        name in interface Tag
        Returns:
        the name of this tag

      • holder

        public Doc holder()
        Deprecated.
        Return the containing Doc of this Tag element.
        Specified by:
        holder in interface Tag
        Returns:
        the containing Doc of this Tag element

      • kind

        public java.lang.String kind()
        Deprecated.
        Return the kind of this tag.
        Specified by:
        kind in interface Tag
        Returns:
        the kind of this tag.

      • text

        public java.lang.String text()
        Deprecated.
        Return the text of this tag, that is, portion beyond tag name.
        Specified by:
        text in interface Tag
        Returns:
        the text of this tag

      • docenv

        DocEnv docenv()
        Deprecated.

      • divideAtWhite

        java.lang.String[] divideAtWhite()
        Deprecated.
        for use by subclasses which have two part tag text.

      • toString

        public java.lang.String toString()
        Deprecated.
        convert this object to a string.
        Specified by:
        toString in interface Tag
        Overrides:
        toString in class java.lang.Object

      • inlineTags

        public Tag[] inlineTags()
        Deprecated.
        For documentation comment with embedded @link tags, return the array of TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s). Within a comment string "This is an example of inline tags for a documentation comment {@link gw.gosudoc.com.sun.javadoc.Doc commentlabel}", where inside the inner braces, the first "Doc" carries exctly the same syntax as a SeeTagImpl and the second "commentlabel" is label for the Html Link, will return an array of TagImpl(s) with first element as TagImpl with comment text "This is an example of inline tags for a documentation comment" and second element as SeeTagImpl with referenced class as "Doc" and the label for the Html Link as "commentlabel".
        Specified by:
        inlineTags in interface Tag
        Returns:
        TagImpl[] Array of tags with inline SeeTagImpls.
        See Also:
        ParamTagImpl, ThrowsTagImpl

      • firstSentenceTags

        public Tag[] firstSentenceTags()
        Deprecated.
        Return array of tags for the first sentence in the doc comment text.
        Specified by:
        firstSentenceTags in interface Tag
        Returns:
        an array of Tag objects representing the first sentence of the comment

      • position

        public SourcePosition position()
        Deprecated.
        Return the doc item to which this tag is attached.
        Specified by:
        position in interface Tag
        Returns:
        the doc item to which this tag is attached.