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

Class BasePropertyTaglet

  • All Implemented Interfaces:
    Taglet
    Direct Known Subclasses:
    PropertyGetterTaglet, PropertySetterTaglet
    @Deprecated
public abstract class BasePropertyTaglet
extends BaseTaglet
    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 
      Constructor Description
      BasePropertyTaglet()
      Deprecated.
       

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      Content getTagletOutput​(Tag tag, TagletWriter tagletWriter)
      Deprecated.
      Given the Tag representation of this custom tag, return its string representation, which is output to the generated page.
      (package private) abstract java.lang.String getText​(TagletWriter tagletWriter)
      Deprecated.
      This method returns the text to be put in the resulting javadoc before the property name.
      boolean inConstructor()
      Deprecated.
      Will return false because this tag may only appear in Methods.
      boolean inOverview()
      Deprecated.
      Will return false because this tag may only appear in Methods.
      boolean inPackage()
      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 isInlineTag()
      Deprecated.
      Will return false because this tag is not inline.

      • 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

      • BasePropertyTaglet

        public BasePropertyTaglet()
        Deprecated.

    • Method Detail

      • getText

        abstract java.lang.String getText​(TagletWriter tagletWriter)
        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

        public Content getTagletOutput​(Tag tag,
                               TagletWriter tagletWriter)
        Deprecated.
        Given the Tag representation of this custom tag, return its string 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.
        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 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 tag may only appear in Methods.
        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 tag may only appear in Methods.
        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 tag may only appear in Methods.
        Specified by:
        inType in interface Taglet
        Overrides:
        inType in class BaseTaglet
        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 interface Taglet
        Overrides:
        isInlineTag in class BaseTaglet
        Returns:
        false since this is not an inline tag.