Interface SerialFieldTag

All Superinterfaces:
Comparable<Object>, Tag
All Known Implementing Classes:
SerialFieldTagImpl

@Deprecated public interface SerialFieldTag extends Tag, Comparable<Object>
Deprecated.
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.
Documents a Serializable field defined by an ObjectStreamField.
 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

 
This tag is only allowed in the javadoc for the special member serialPersistentFields.
See Also:
  • Method Details

    • fieldName

      String fieldName()
      Deprecated.
      Return the serializable field name.
      Returns:
      the serializable field name.
    • fieldType

      String fieldType()
      Deprecated.
      Return the field type string.
      Returns:
      the field type string.
    • fieldTypeDoc

      ClassDoc fieldTypeDoc()
      Deprecated.
      Return the ClassDoc for field type.
      Returns:
      null if no ClassDoc for field type is visible from containingClass context.
    • description

      String description()
      Deprecated.
      Return the field comment. If there is no serialField comment, return javadoc comment of corresponding FieldDoc.
      Returns:
      the field comment. If there is no serialField comment, return javadoc comment of corresponding FieldDoc.
    • compareTo

      int compareTo(Object obj)
      Deprecated.
      Compares this Object with the specified Object for order. Returns a negative integer, zero, or a positive integer as this Object is less than, equal to, or greater than the given Object.

      Included to make SerialFieldTag items java.lang.Comparable.

      Specified by:
      compareTo in interface Comparable<Object>
      Parameters:
      obj - the Object to be compared.
      Returns:
      a negative integer, zero, or a positive integer as this Object is less than, equal to, or greater than the given Object.
      Throws:
      ClassCastException - the specified Object's type prevents it from being compared to this Object.
      Since:
      1.2