Class: java.io.ObjectStreamClass

Serialization's descriptor for classes. It contains the name and serialVersionUID of the class. The ObjectStreamClass for a specific class loaded in this Java VM can be found/created using the lookup method.

The algorithm to compute the SerialVersionUID is described in Object Serialization Specification, Section 4.6, Stream Unique Identifiers.

Authors:
@author Mike Warres
@author Roger Riggs
See:
@see java.io.ObjectStreamField
@see Object Serialization Specification, Section 4, Class Descriptors
Since:
@since JDK1.1

Inheritance

Superclass tree: Implements:

Methods

  • forClasstop

    public Class<?> forClass()
    Return the class in the local VM that this version is mapped to. Null is returned if there is no corresponding local class.
    Return:
    @return the Class instance that this descriptor represents
    Related Links:
    Google Code Search
    Stack Overflow

  • getFieldtop

    public ObjectStreamField getField(String name)
    Get the field of this class by name.
    Parameters:
    @param name the name of the data field to look for
    Return:
    @return The ObjectStreamField object of the named field or null if there is no such named field.
    Related Links:
    Google Code Search
    Stack Overflow

  • getFieldstop

    public ObjectStreamField[] getFields()
    Return an array of the fields of this serializable class.
    Return:
    @return an array containing an element for each persistent field of this class. Returns an array of length zero if there are no fields.
    Since:
    @since 1.2
    Related Links:
    Google Code Search
    Stack Overflow

  • getNametop

    public String getName()
    Returns the name of the class described by this descriptor. This method returns the name of the class in the format that is used by the Class.getName() method.
    Return:
    @return a string representing the name of the class
    Related Links:
    Google Code Search
    Stack Overflow

  • getSerialVersionUIDtop

    public long getSerialVersionUID()
    Return the serialVersionUID for this class. The serialVersionUID defines a set of classes all with the same name that have evolved from a common root class and agree to be serialized and deserialized using a common format. NonSerializable classes have a serialVersionUID of 0L.
    Return:
    @return the SUID of the class described by this descriptor
    Related Links:
    Google Code Search
    Stack Overflow

  • lookuptop

    public static ObjectStreamClass lookup(Class<?> cl)
    Find the descriptor for a class that can be serialized. Creates an ObjectStreamClass instance if one does not exist yet for class. Null is returned if the specified class does not implement java.io.Serializable or java.io.Externalizable.
    Parameters:
    @param cl class for which to get the descriptor
    Return:
    @return the class descriptor for the specified class
    Related Links:
    Google Code Search
    Stack Overflow

  • lookupAnytop

    public static ObjectStreamClass lookupAny(Class<?> cl)
    Returns the descriptor for any class, regardless of whether it implements java.io.Serializable.
    Parameters:
    @param cl class for which to get the descriptor
    Return:
    @return the class descriptor for the specified class
    Since:
    @since 1.6
    Related Links:
    Google Code Search
    Stack Overflow

  • toStringtop

    public String toString()
    Return a string describing this ObjectStreamClass.
    Return:
    @return a string representation of the object.
    Override hierarchy:
    toString from Object
    Related Links:
    Google Code Search
    Stack Overflow

Fields

  • NO_FIELDS

    public static final ObjectStreamField[] NO_FIELDS
    serialPersistentFields value indicating no serializable fields