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

Class SerializedForm

  • @Deprecated
class SerializedForm
extends java.lang.Object
    Deprecated.
    The serialized form is the specification of a class' serialization state.

    It consists of the following information:

     1. Whether class is Serializable or Externalizable.
 2. Javadoc for serialization methods.
    a. For Serializable, the optional readObject, writeObject,
       readResolve and writeReplace.
       serialData tag describes, in prose, the sequence and type
       of optional data written by writeObject.
    b. For Externalizable, writeExternal and readExternal.
       serialData tag describes, in prose, the sequence and type
       of optional data written by writeExternal.
 3. Javadoc for serialization data layout.
    a. For Serializable, the name,type and description
       of each Serializable fields.
    b. For Externalizable, data layout is described by 2(b).

    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.

    Since:
    1.2

    • Field Detail

      • methods

        com.sun.tools.javac.util.ListBuffer<MethodDoc> methods
        Deprecated.

      • fields

        private final com.sun.tools.javac.util.ListBuffer<FieldDocImpl> fields
        Deprecated.

      • definesSerializableFields

        private boolean definesSerializableFields
        Deprecated.

      • SERIALIZABLE_FIELDS

        private static final java.lang.String SERIALIZABLE_FIELDS
        Deprecated.
        See Also:
        Constant Field Values

      • READOBJECT

        private static final java.lang.String READOBJECT
        Deprecated.
        See Also:
        Constant Field Values

      • WRITEOBJECT

        private static final java.lang.String WRITEOBJECT
        Deprecated.
        See Also:
        Constant Field Values

      • READRESOLVE

        private static final java.lang.String READRESOLVE
        Deprecated.
        See Also:
        Constant Field Values

      • WRITEREPLACE

        private static final java.lang.String WRITEREPLACE
        Deprecated.
        See Also:
        Constant Field Values

      • READOBJECTNODATA

        private static final java.lang.String READOBJECTNODATA
        Deprecated.
        See Also:
        Constant Field Values

    • Constructor Detail

      • SerializedForm

        SerializedForm​(DocEnv env,
               com.sun.tools.javac.code.Symbol.ClassSymbol def,
               ClassDocImpl cd)
        Deprecated.
        Constructor. Catalog Serializable fields for Serializable class. Catalog serialization methods for Serializable and Externalizable classes.

    • Method Detail

      • getDefinedSerializableFields

        private com.sun.tools.javac.code.Symbol.VarSymbol getDefinedSerializableFields​(com.sun.tools.javac.code.Symbol.ClassSymbol def)
        Deprecated.

      • computeDefaultSerializableFields

        private void computeDefaultSerializableFields​(DocEnv env,
                                              com.sun.tools.javac.code.Symbol.ClassSymbol def,
                                              ClassDocImpl cd)
        Deprecated.

      • addMethodIfExist

        private void addMethodIfExist​(DocEnv env,
                              com.sun.tools.javac.code.Symbol.ClassSymbol def,
                              java.lang.String methodName)
        Deprecated.

      • mapSerialFieldTagImplsToFieldDocImpls

        private void mapSerialFieldTagImplsToFieldDocImpls​(FieldDocImpl spfDoc,
                                                   DocEnv env,
                                                   com.sun.tools.javac.code.Symbol.ClassSymbol def)
        Deprecated.

      • fields

        FieldDoc[] fields()
        Deprecated.
        Return serializable fields in class.

        Returns either a list of default fields documented by serial tag comment or javadoc comment

        Or Returns a single FieldDocImpl for serialPersistentField. There is a serialField tag for each serializable field.

        Returns:
        an array of FieldDocImpl for representing the visible fields in this class.

      • methods

        MethodDoc[] methods()
        Deprecated.
        Return serialization methods in class.
        Returns:
        an array of MethodDocImpl for serialization methods in this class.

      • definesSerializableFields

        boolean definesSerializableFields()
        Deprecated.
        Returns true if Serializable fields are defined explicitly using member, serialPersistentFields.
        See Also:
        fields()