Module  jdk.javadoc
软件包  com.sun.tools.doclets

Interface Taglet

  • 已过时。
    该接口已被替换， Taglet取代。 

    @Deprecated
public interface Taglet
    Doclets使用的自定义标签的界面。 自定义标签必须实现此接口。

    注意：此接口已被替换， Taglet替代。

    要在运行时由doclet加载和使用，taglet必须具有一个名为register的静态方法，该方法接受Map作为具有以下签名的参数： 
      public void register(Map map)
    该方法应该将自定义taglet的实例添加到地图中，其中taglet的名称作为关键字。 如果覆盖一个taglet，为了避免名称冲突，必须先从地图中删除被覆盖的taglet，然后再将新taglet的实例添加到地图中。

    建议taglet在注册失败时引发异常。 它抛出的异常取决于用户。

    以下是两个示例标签：

    有关如何创建自己的Taglets的更多信息，请参阅Taglet Overview 。

    从以下版本开始：
    1.4

    • 方法摘要

      所有方法  接口方法  抽象方法  弃用的方法 
      Modifier and Type 方法 描述
      String getName​()
      已过时。
      返回此自定义标签的名称。
      boolean inConstructor​()
      已过时。
      如果在构造函数文档中使用了这个 Taglet则返回true。
      boolean inField​()
      已过时。
      如果在现场文档中使用 Taglet则返回true。
      boolean inMethod​()
      已过时。
      如果在方法文档中使用了 Taglet则返回true。
      boolean inOverview​()
      已过时。
      如果在概述文档中使用了 Taglet则返回true。
      boolean inPackage​()
      已过时。
      如果在包文档中使用了 Taglet则返回true。
      boolean inType​()
      已过时。
      如果在类型文档（类或接口）中使用了 Taglet则返回true。
      boolean isInlineTag​()
      已过时。
      如果这个 Taglet是内联标签，则返回true。
      String toString​(Tag tag)
      已过时。
      给定此自定义标签的 Tag表示形式，返回其字符串表示形式，将其输出到生成的页面。
      String toString​(Tag[] tags)
      已过时。
      给定一个表示此自定义标签的数组 Tag s，返回其字符串表示，将其输出到生成的页面。

    • 方法详细信息

      • inField

        boolean inField​()
        已过时。
        如果在现场文档中使用了Taglet则返回true。 为内联标签设置为false。
        结果
        如果在现场文档中使用了 Taglet则为true，否则为false。

      • inConstructor

        boolean inConstructor​()
        已过时。
        如果在构造函数文档中使用了这个Taglet则返回true。 为内联标签设置为false。
        结果
        如果在构造函数文档中使用了 Taglet则为true，否则为false。

      • inMethod

        boolean inMethod​()
        已过时。
        如果在方法文档中使用了这个Taglet则返回true。 为内联标签设置为false。
        结果
        如果在方法文档中使用此 Taglet则为true，否则为false。

      • inOverview

        boolean inOverview​()
        已过时。
        如果在概述文档中使用了Taglet则返回true。 为内联标签设置为false。
        结果
        如果在方法文档中使用了 Taglet则为true，否则为false。

      • inPackage

        boolean inPackage​()
        已过时。
        如果在包文档中使用了Taglet则返回true。 为内联标签设置为false。
        结果
        如果在包文档中使用了 Taglet则为true，否则为false。

      • inType

        boolean inType​()
        已过时。
        如果在类型文档（类或接口）中使用了Taglet则返回true。 为内联标签设置为false。
        结果
        如果在类型文档中使用了 Taglet则为true，否则为false。

      • isInlineTag

        boolean isInlineTag​()
        已过时。
        如果这是Taglet是一个内联标签，返回true。 否则返回false。
        结果
        如果这是 Taglet是一个内联标签， Taglet true，否则为false。

      • getName

        String getName​()
        已过时。
        返回此自定义标签的名称。
        结果
        这个自定义标签的名称。

      • toString

        String toString​(Tag tag)
        已过时。
        给定此自定义标签的 Tag表示形式，返回其字符串表示形式，将其输出到生成的页面。
        参数
        tag - 这个自定义标签的 Tag表示。
        结果
        该字符串表示为 Tag 。

      • toString

        String toString​(Tag[] tags)
        已过时。
        给定一个表示此自定义标签的数组Tag s，返回其字符串表示形式，将其输出到生成的页面。 如果此taglet表示内联标记，则此方法应返回null。
        参数
        tags - 表示此自定义标签的 Tag s的数组。
        结果
        该字符串表示为 Tag 。