FileDocCategorySizeDatePackage
SerialFieldTag.javaAPI DocJava SE 5 API2011Fri Aug 26 14:54:54 BST 2005com.sun.javadoc

SerialFieldTag

public interface SerialFieldTag implements Comparable, Tag
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.
author
Joe Fialli
see
java.io.ObjectStreamField

Fields Summary
Constructors Summary
Methods Summary
public intcompareTo(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.

param
obj the Object to be compared.
return
a negative integer, zero, or a positive integer as this Object is less than, equal to, or greater than the given Object.
exception
ClassCastException the specified Object's type prevents it from being compared to this Object.
since
JDK1.2

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

public java.lang.StringfieldName()
Return the serialziable field name.

public java.lang.StringfieldType()
Return the field type string.

public com.sun.javadoc.ClassDocfieldTypeDoc()
Return the ClassDoc for field type.

return
null if no ClassDoc for field type is visible from containingClass context.