public class

ObjectStreamClass

extends Object
implements Serializable
java.lang.Object
   ↳ java.io.ObjectStreamClass

Class Overview

Represents a descriptor for identifying a class during serialization and deserialization. Information contained in the descriptor includes the name and SUID of the class as well as field names and types. Information inherited from the superclasses is also taken into account.

See Also

Summary

Constants
ObjectStreamField[] NO_FIELDS Constant indicating that the class has no Serializable fields.
Public Methods
Class<?> forClass()
Returns the class (java.lang.Class) for this descriptor.
ObjectStreamField getField(String name)
Gets a field descriptor of the class represented by this class descriptor.
ObjectStreamField[] getFields()
Returns a collection of field descriptors for the serialized fields of the class represented by this class descriptor.
String getName()
Returns the name of the class represented by this descriptor.
long getSerialVersionUID()
Returns the Serial Version User ID of the class represented by this descriptor.
static ObjectStreamClass lookup(Class<?> cl)
Returns the descriptor for a serializable class.
static ObjectStreamClass lookupAny(Class<?> cl)
Returns the descriptor for any class, whether or not the class implements Serializable or Externalizable.
String toString()
Returns a string containing a concise, human-readable description of this descriptor.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final ObjectStreamField[] NO_FIELDS

Since: API Level 1

Constant indicating that the class has no Serializable fields.

Public Methods

public Class<?> forClass ()

Since: API Level 1

Returns the class (java.lang.Class) for this descriptor.

Returns
  • the class in the local VM that this descriptor represents; null if there is no corresponding class.

public ObjectStreamField getField (String name)

Since: API Level 1

Gets a field descriptor of the class represented by this class descriptor.

Parameters
name the name of the desired field.
Returns
  • the field identified by name or null if there is no such field.

public ObjectStreamField[] getFields ()

Since: API Level 1

Returns a collection of field descriptors for the serialized fields of the class represented by this class descriptor.

Returns
  • an array of field descriptors or an array of length zero if there are no fields in this descriptor's class.

public String getName ()

Since: API Level 1

Returns the name of the class represented by this descriptor.

Returns
  • the fully qualified name of the class this descriptor represents.

public long getSerialVersionUID ()

Since: API Level 1

Returns the Serial Version User ID of the class represented by this descriptor.

Returns
  • the SUID for the class represented by this descriptor.

public static ObjectStreamClass lookup (Class<?> cl)

Since: API Level 1

Returns the descriptor for a serializable class. Returns null if the class doesn't implement Serializable or Externalizable.

Parameters
cl a java.lang.Class for which to obtain the corresponding descriptor
Returns
  • the corresponding descriptor if the class is serializable or externalizable; null otherwise.

public static ObjectStreamClass lookupAny (Class<?> cl)

Since: API Level 9

Returns the descriptor for any class, whether or not the class implements Serializable or Externalizable.

Parameters
cl a java.lang.Class for which to obtain the corresponding descriptor
Returns
  • the descriptor

public String toString ()

Since: API Level 1

Returns a string containing a concise, human-readable description of this descriptor.

Returns
  • a printable representation of this descriptor.