模块  jdk.javadoc
软件包  com.sun.javadoc

Interface SerialFieldTag

  • All Superinterfaces:
    Comparable<Object>Tag

    @Deprecated(since="9",
                forRemoval=true)
    public interface SerialFieldTag
    extends Tag, Comparable<Object>
    Deprecated, for removal: This API element is subject to removal in a future version.
    The declarations in this package have been superseded by those in the package jdk.javadoc.doclet. For more information, see the Migration Guide in the documentation for that package.
    记录由ObjectStreamField定义的Serializable字段。
      The class parses and stores the three serialField tag parameters:
    
     - field name
     - field type name
          (fully-qualified or visible from the current import context)
     - description of the valid values for the field 
    此标记仅允许在特殊成员serialPersistentFields的javadoc中使用。
    另请参见:
    ObjectStreamField
    • 方法详细信息

      • fieldName

        String fieldName()
        Deprecated, for removal: This API element is subject to removal in a future version.
        返回可序列化字段名称。
        结果
        可序列化的字段名称。
      • fieldType

        String fieldType()
        Deprecated, for removal: This API element is subject to removal in a future version.
        返回字段类型字符串。
        结果
        字段类型字符串。
      • fieldTypeDoc

        ClassDoc fieldTypeDoc()
        Deprecated, for removal: This API element is subject to removal in a future version.
        返回ClassDoc以获取字段类型。
        结果
        如果从containsClass上下文中看不到字段类型的ClassDoc,则返回null。
      • description

        String description()
        Deprecated, for removal: This API element is subject to removal in a future version.
        返回字段注释。 如果没有serialField注释,则返回相应FieldDoc的javadoc注释。
        结果
        现场评论。 如果没有serialField注释,则返回相应FieldDoc的javadoc注释。
      • compareTo

        int compareTo​(Object obj)
        Deprecated, for removal: This API element is subject to removal in a future version.
        将此Object与指定的Object进行比较以获取顺序。 返回负整数,零或正整数,因为此Object小于,等于或大于给定的Object。

        包含使SerialFieldTag项java.lang.Comparable。

        Specified by:
        compareTo在界面 Comparable<Object>
        参数
        obj - 要比较的 Object
        结果
        一个负整数,零或正整数,因为此Object小于,等于或大于给定的Object。
        异常
        ClassCastException - 指定的Object类型阻止将其与此Object进行比较。
        从以下版本开始:
        1.2