Class SerialFieldTagImpl
java.lang.Object
gw.gosudoc.com.sun.tools.javadoc.main.TagImpl
gw.gosudoc.com.sun.tools.javadoc.main.SerialFieldTagImpl
- All Implemented Interfaces:
SerialFieldTag
,Tag
,Comparable<Object>
Deprecated.
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 fieldThis tag is only allowed in the javadoc for the special member serialPersistentFields.
This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
Deprecated.Compares this Object with the specified Object for order.Deprecated.Return the field comment.Deprecated.Return the serialziable field name.Deprecated.Return the field type string.Deprecated.Return the ClassDocImpl for field type.(package private) FieldDocImpl
Deprecated.Return the corresponding FieldDocImpl for this SerialFieldTagImpl.(package private) String
key()
Deprecated.return a key for sorting.kind()
Deprecated.Return the kind of this tag.(package private) void
Deprecated.private void
Deprecated.toString()
Deprecated.Convert this object to a string.Methods inherited from class gw.gosudoc.com.sun.tools.javadoc.main.TagImpl
divideAtWhite, docenv, firstSentenceTags, holder, inlineTags, name, position, text
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface gw.gosudoc.com.sun.javadoc.Tag
firstSentenceTags, holder, inlineTags, name, position, text
-
Field Details
-
fieldName
Deprecated. -
fieldType
Deprecated. -
description
Deprecated. -
containingClass
Deprecated. -
fieldTypeDoc
Deprecated. -
matchingField
Deprecated.
-
-
Constructor Details
-
SerialFieldTagImpl
Deprecated.
-
-
Method Details
-
parseSerialFieldString
private void parseSerialFieldString()Deprecated. -
key
String key()Deprecated.return a key for sorting. -
mapToFieldDocImpl
Deprecated. -
fieldName
Deprecated.Return the serialziable field name.- Specified by:
fieldName
in interfaceSerialFieldTag
- Returns:
- the serializable field name.
-
fieldType
Deprecated.Return the field type string.- Specified by:
fieldType
in interfaceSerialFieldTag
- Returns:
- the field type string.
-
fieldTypeDoc
Deprecated.Return the ClassDocImpl for field type.- Specified by:
fieldTypeDoc
in interfaceSerialFieldTag
- Returns:
- null if no ClassDoc for field type is visible from containingClass context.
-
getMatchingField
FieldDocImpl getMatchingField()Deprecated.Return the corresponding FieldDocImpl for this SerialFieldTagImpl. -
description
Deprecated.Return the field comment. If there is no serialField comment, return javadoc comment of corresponding FieldDocImpl.- Specified by:
description
in interfaceSerialFieldTag
- Returns:
- the field comment. If there is no serialField comment, return javadoc comment of corresponding FieldDoc.
-
kind
Deprecated.Return the kind of this tag. -
toString
Deprecated.Convert this object to a string. -
compareTo
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 SerialFieldTagImpl items java.lang.Comparable.
- Specified by:
compareTo
in interfaceComparable<Object>
- Specified by:
compareTo
in interfaceSerialFieldTag
- Parameters:
obj
- theObject
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
-