Interface SerialFieldTag

All Superinterfaces:
Comparable<Object>, Tag 
@Deprecated(since="9",
            forRemoval=true)
public interface SerialFieldTag
extends Tag, Comparable<Object>
Deprecated, for removal: This API element is subject to removal in a future version.
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:
ObjectStreamField

Methods

Modifier and Type Method Description
int compareTo​(Object obj)

Deprecated, for removal: This API element is subject to removal in a future version.

Compares this Object with the specified Object for order.
String description()

Deprecated, for removal: This API element is subject to removal in a future version.

Return the field comment.
String fieldName()

Deprecated, for removal: This API element is subject to removal in a future version.

Return the serializable field name.
String fieldType()

Deprecated, for removal: This API element is subject to removal in a future version.

Return the field type string.
ClassDoc fieldTypeDoc()

Deprecated, for removal: This API element is subject to removal in a future version.

Return the ClassDoc for field type.

Methods declared in interface com.sun.javadoc.Tag

firstSentenceTags, holder, inlineTags, kind, name, position, text, toString

Methods

fieldName

String fieldName()
Deprecated, for removal: This API element is subject to removal in a future version.

Return the serializable field name.

Returns:
the serializable field name.

fieldType

String fieldType()
Deprecated, for removal: This API element is subject to removal in a future version.

Return the field type string.

Returns:
the field type string.

fieldTypeDoc

ClassDoc fieldTypeDoc()
Deprecated, for removal: This API element is subject to removal in a future version.

Return the ClassDoc for field type.

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

description

String description()
Deprecated, for removal: This API element is subject to removal in a future version.

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, for removal: This API element is subject to removal in a future version.

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

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/11/docs/api/jdk.javadoc/com/sun/javadoc/SerialFieldTag.html