Package gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets

Class ValueTaglet

  • All Implemented Interfaces:
    Taglet
    @Deprecated
public class ValueTaglet
extends BaseInlineTaglet
    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 
      Constructor Description
      ValueTaglet()
      Deprecated.
      Construct a new ValueTaglet.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      private FieldDoc getFieldDoc​(Configuration config, Tag tag, java.lang.String name)
      Deprecated.
      Given the name of the field, return the corresponding FieldDoc.
      Content getTagletOutput​(Tag tag, TagletWriter writer)
      Deprecated.
      Given the Tag representation of this custom tag, return its Content representation, which is output to the generated page.
      boolean inConstructor()
      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 inOverview()
      Deprecated.
      Will return false because this inline tag may only appear in Fields.
      boolean inPackage()
      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 java.lang.Object

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

      • Methods inherited from interface gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.Taglet

        toString

    • Constructor Detail

      • ValueTaglet

        public ValueTaglet()
        Deprecated.
        Construct a new ValueTaglet.

    • Method Detail

      • inMethod

        public boolean inMethod()
        Deprecated.
        Will return false because this inline tag may only appear in Fields.
        Specified by:
        inMethod in interface Taglet
        Overrides:
        inMethod in class BaseTaglet
        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 interface Taglet
        Overrides:
        inConstructor in class BaseTaglet
        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 interface Taglet
        Overrides:
        inOverview in class BaseTaglet
        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 interface Taglet
        Overrides:
        inPackage in class BaseTaglet
        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 interface Taglet
        Overrides:
        inType in class BaseTaglet
        Returns:
        false since this is not a method.

      • getFieldDoc

        private FieldDoc getFieldDoc​(Configuration config,
                             Tag tag,
                             java.lang.String name)
        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

        public Content getTagletOutput​(Tag tag,
                               TagletWriter writer)
        Deprecated.
        Given the Tag representation of this custom tag, return its Content representation, which is output to the generated page.
        Specified by:
        getTagletOutput in interface Taglet
        Overrides:
        getTagletOutput in class BaseTaglet
        Parameters:
        tag - the Tag representation of this custom tag.
        writer - a TagletWriter Taglet writer.
        Returns:
        the Content representation of this Tag.