|
Doclet API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface SerialFieldTag
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.
ObjectStreamField| Method Summary | |
|---|---|
int |
compareTo(Object obj)
Compares this Object with the specified Object for order. |
String |
description()
Return the field comment. |
String |
fieldName()
Return the serialziable field name. |
String |
fieldType()
Return the field type string. |
ClassDoc |
fieldTypeDoc()
Return the ClassDoc for field type. |
| Methods inherited from interface com.sun.javadoc.Tag |
|---|
firstSentenceTags, holder, inlineTags, kind, name, position, text, toString |
| Method Detail |
|---|
String fieldName()
String fieldType()
ClassDoc fieldTypeDoc()
String description()
int compareTo(Object obj)
Included to make SerialFieldTag items java.lang.Comparable.
compareTo in interface Comparable<Object>obj - the Object to be compared.
ClassCastException - the specified Object's type prevents it
from being compared to this Object.
|
Doclet API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||