com.sun.javadoc
Interface SerialFieldTag


public abstract interface SerialFieldTag
extends Tag, java.lang.Comparable

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:
ObjectStreamField

Fields inherited from class java.io.Serializable
serialVersionUID
 
Method Summary
 int compareTo(java.lang.Object obj)
          Compares this Object with the specified Object for order.
 java.lang.String description()
          Return the field comment.
 java.lang.String fieldName()
          Return the serialziable field name.
 java.lang.String fieldType()
          Return the field type string.
 ClassDoc fieldTypeDoc()
          Return the ClassDoc for field type.
 
Methods inherited from interface com.sun.javadoc.Tag
firstSentenceTags, inlineTags, kind, name, text, toString
 

Method Detail

fieldName

public java.lang.String fieldName()
Return the serialziable field name.

fieldType

public java.lang.String fieldType()
Return the field type string.

fieldTypeDoc

public ClassDoc fieldTypeDoc()
Return the ClassDoc for field type.

description

public java.lang.String description()
Return the field comment. If there is no serialField comment, return javadoc comment of corresponding FieldDoc.

compareTo

public int compareTo(java.lang.Object obj)
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 java.lang.Comparable
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:
JDK1.2