- java.lang.Object
-
- java.io.ObjectStreamClass
-
- All Implemented Interfaces:
- Serializable
public class ObjectStreamClass extends Object implements Serializable
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.
- Since:
- JDK1.1
- See Also:
ObjectStreamField
, Object Serialization Specification, Section 4, Class Descriptors, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description static ObjectStreamField[]
NO_FIELDS
serialPersistentFields value indicating no serializable fields
-
Method Summary
Methods Modifier and Type Method and Description 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 implementsSerializable
.String
toString()
Return a string describing this ObjectStreamClass.
-
-
-
Field Detail
-
NO_FIELDS
public static final ObjectStreamField[] NO_FIELDS
serialPersistentFields value indicating no serializable fields
-
-
Method Detail
-
lookup
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:
cl
- class for which to get the descriptor- Returns:
- the class descriptor for the specified class
-
lookupAny
public static ObjectStreamClass lookupAny(Class<?> cl)
Returns the descriptor for any class, regardless of whether it implementsSerializable
.- Parameters:
cl
- class for which to get the descriptor- Returns:
- the class descriptor for the specified class
- Since:
- 1.6
-
getName
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 theClass.getName()
method.- Returns:
- a string representing the name of the class
-
getSerialVersionUID
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.- Returns:
- the SUID of the class described by this descriptor
-
forClass
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.- Returns:
- the
Class
instance that this descriptor represents
-
getFields
public ObjectStreamField[] getFields()
Return an array of the fields of this serializable class.- Returns:
- an array containing an element for each persistent field of this class. Returns an array of length zero if there are no fields.
- Since:
- 1.2
-
getField
public ObjectStreamField getField(String name)
Get the field of this class by name.- Parameters:
name
- the name of the data field to look for- Returns:
- The ObjectStreamField object of the named field or null if there is no such named field.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/io/objectstreamclass.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.