Package gw.gosudoc.com.sun.tools.javadoc.main

Class SerialFieldTagImpl

  • All Implemented Interfaces:
    SerialFieldTag, Tag, java.lang.Comparable<java.lang.Object>
    @Deprecated
class SerialFieldTagImpl
extends TagImpl
implements SerialFieldTag, java.lang.Comparable<java.lang.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 field
    This 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:
    ObjectStreamField

    • Field Detail

      • fieldName

        private java.lang.String fieldName
        Deprecated.

      • fieldType

        private java.lang.String fieldType
        Deprecated.

      • description

        private java.lang.String description
        Deprecated.

      • containingClass

        private ClassDoc containingClass
        Deprecated.

      • fieldTypeDoc

        private ClassDoc fieldTypeDoc
        Deprecated.

      • matchingField

        private FieldDocImpl matchingField
        Deprecated.

    • Constructor Detail

      • SerialFieldTagImpl

        SerialFieldTagImpl​(DocImpl holder,
                   java.lang.String name,
                   java.lang.String text)
        Deprecated.

    • Method Detail

      • parseSerialFieldString

        private void parseSerialFieldString()
        Deprecated.

      • key

        java.lang.String key()
        Deprecated.
        return a key for sorting.

      • mapToFieldDocImpl

        void mapToFieldDocImpl​(FieldDocImpl fd)
        Deprecated.

      • fieldName

        public java.lang.String fieldName()
        Deprecated.
        Return the serialziable field name.
        Specified by:
        fieldName in interface SerialFieldTag
        Returns:
        the serializable field name.

      • fieldType

        public java.lang.String fieldType()
        Deprecated.
        Return the field type string.
        Specified by:
        fieldType in interface SerialFieldTag
        Returns:
        the field type string.

      • fieldTypeDoc

        public ClassDoc fieldTypeDoc()
        Deprecated.
        Return the ClassDocImpl for field type.
        Specified by:
        fieldTypeDoc in interface SerialFieldTag
        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

        public java.lang.String description()
        Deprecated.
        Return the field comment. If there is no serialField comment, return javadoc comment of corresponding FieldDocImpl.
        Specified by:
        description in interface SerialFieldTag
        Returns:
        the field comment. If there is no serialField comment, return javadoc comment of corresponding FieldDoc.

      • kind

        public java.lang.String kind()
        Deprecated.
        Return the kind of this tag.
        Specified by:
        kind in interface Tag
        Overrides:
        kind in class TagImpl
        Returns:
        the kind of this tag.

      • toString

        public java.lang.String toString()
        Deprecated.
        Convert this object to a string.
        Specified by:
        toString in interface Tag
        Overrides:
        toString in class TagImpl

      • compareTo

        public int compareTo​(java.lang.Object obj)
        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 interface java.lang.Comparable<java.lang.Object>
        Specified by:
        compareTo in interface SerialFieldTag
        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:
        java.lang.ClassCastException - the specified Object's type prevents it from being compared to this Object.
        Since:
        1.2