Interface Taglet

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      String getName()
      Deprecated.
      Return the name of this custom tag.
      Content getTagletOutput​(Doc holder, TagletWriter writer)
      Deprecated.
      Given a Doc object, check if it holds any tags of this type.
      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.
      Return true if this Taglet is used in constructor documentation.
      boolean inField()
      Deprecated.
      Return true if this Taglet is used in field documentation.
      boolean inMethod()
      Deprecated.
      Return true if this Taglet is used in method documentation.
      boolean inOverview()
      Deprecated.
      Return true if this Taglet is used in overview documentation.
      boolean inPackage()
      Deprecated.
      Return true if this Taglet is used in package documentation.
      boolean inType()
      Deprecated.
      Return true if this Taglet is used in type documentation (classes or interfaces).
      boolean isInlineTag()
      Deprecated.
      Return true if this Taglet is an inline tag.
      String toString()
      Deprecated.
       
    • Method Detail

      • inField

        boolean inField()
        Deprecated.
        Return true if this Taglet is used in field documentation.
        Returns:
        true if this Taglet is used in field documentation and false otherwise.
      • inConstructor

        boolean inConstructor()
        Deprecated.
        Return true if this Taglet is used in constructor documentation.
        Returns:
        true if this Taglet is used in constructor documentation and false otherwise.
      • inMethod

        boolean inMethod()
        Deprecated.
        Return true if this Taglet is used in method documentation.
        Returns:
        true if this Taglet is used in method documentation and false otherwise.
      • inOverview

        boolean inOverview()
        Deprecated.
        Return true if this Taglet is used in overview documentation.
        Returns:
        true if this Taglet is used in method documentation and false otherwise.
      • inPackage

        boolean inPackage()
        Deprecated.
        Return true if this Taglet is used in package documentation.
        Returns:
        true if this Taglet is used in package documentation and false otherwise.
      • inType

        boolean inType()
        Deprecated.
        Return true if this Taglet is used in type documentation (classes or interfaces).
        Returns:
        true if this Taglet is used in type documentation and false otherwise.
      • isInlineTag

        boolean isInlineTag()
        Deprecated.
        Return true if this Taglet is an inline tag. Return false otherwise.
        Returns:
        true if this Taglet is an inline tag and false otherwise.
      • getName

        String getName()
        Deprecated.
        Return the name of this custom tag.
        Returns:
        the name of this custom tag.
      • getTagletOutput

        Content getTagletOutput​(Tag tag,
                                TagletWriter writer)
                         throws IllegalArgumentException
        Deprecated.
        Given the Tag representation of this custom tag, return its Content representation, which is output to the generated page.
        Parameters:
        tag - the Tag representation of this custom tag.
        writer - a TagletWriter Taglet writer.
        Returns:
        the Content representation of this Tag.
        Throws:
        IllegalArgumentException - thrown when the method is not supported by the taglet.
      • getTagletOutput

        Content getTagletOutput​(Doc holder,
                                TagletWriter writer)
                         throws IllegalArgumentException
        Deprecated.
        Given a Doc object, check if it holds any tags of this type. If it does, return the string representing the output. If it does not, return null.
        Parameters:
        holder - a Doc object holding the custom tag.
        writer - a TagletWriter Taglet writer.
        Returns:
        the TagletOutput representation of this Tag.
        Throws:
        IllegalArgumentException - thrown when the method is not supported by the taglet.