Skip to content

Most visited

Recently visited

navigation

ObjectStreamClass

public class ObjectStreamClass
extends Object implements Serializable

java.lang.Object
   ↳ 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.

See also:

Summary

Fields

public static final ObjectStreamField[] NO_FIELDS

serialPersistentFields value indicating no serializable fields

Public methods

Class<?> forClass()

Return the class in the local VM that this version is mapped to.

ObjectStreamField getField(String name)

Get the field of this class by name.

ObjectStreamField[] getFields()

Return an array of the fields of this serializable class.

String getName()

Returns the name of the class described by this descriptor.

long getSerialVersionUID()

Return the serialVersionUID for this class.

static ObjectStreamClass lookup(Class<?> cl)

Find the descriptor for a class that can be serialized.

static ObjectStreamClass lookupAny(Class<?> cl)

Returns the descriptor for any class, regardless of whether it implements Serializable.

String toString()

Return a string describing this ObjectStreamClass.

Inherited methods

From class java.lang.Object

Fields

NO_FIELDS

Added in API level 1
ObjectStreamField[] NO_FIELDS

serialPersistentFields value indicating no serializable fields

Public methods

forClass

Added in API level 1
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.

Returns
Class<?> the Class instance that this descriptor represents

getField

Added in API level 1
ObjectStreamField getField (String name)

Get the field of this class by name.

Parameters
name String: the name of the data field to look for
Returns
ObjectStreamField The ObjectStreamField object of the named field or null if there is no such named field.

getFields

Added in API level 1
ObjectStreamField[] getFields ()

Return an array of the fields of this serializable class.

Returns
ObjectStreamField[] an array containing an element for each persistent field of this class. Returns an array of length zero if there are no fields.

getName

Added in API level 1
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 getName() method.

Returns
String a string representing the name of the class

getSerialVersionUID

Added in API level 1
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.

Returns
long the SUID of the class described by this descriptor

lookup

Added in API level 1
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
cl Class: class for which to get the descriptor
Returns
ObjectStreamClass the class descriptor for the specified class

lookupAny

Added in API level 9
ObjectStreamClass lookupAny (Class<?> cl)

Returns the descriptor for any class, regardless of whether it implements Serializable.

Parameters
cl Class: class for which to get the descriptor
Returns
ObjectStreamClass the class descriptor for the specified class

toString

Added in API level 1
String toString ()

Return a string describing this ObjectStreamClass.

Returns
String a string representation of the object.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.