OpenJDK 1.23 · java.io.ObjectStreamField · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final Field	field corresponding reflective field object, if any
private final String	name field name
private int	offset offset of field value in enclosing field group
private final String	signature canonical JVM signature of field type, if given
private final Class<?>	type field type (Object.class if unknown non-primitive type)
private String	typeSignature lazily constructed signature for the type, if no explicit signature
private final boolean	unshared whether or not to (de)serialize field values as unshared

Constructor Summary

Access	Constructor and Description
public	ObjectStreamField(String the name of the serializable field name, Class<?> the `Class` object of the serializable field type) Create a Serializable field with the specified type.
public	ObjectStreamField(String field name name, Class<?> field type type, boolean if false, write/read field values in the same manner as writeObject/readObject; if true, write/read in the same manner as writeUnshared/readUnshared unshared) Creates an ObjectStreamField representing a serializable field with the given name and type.
pack-priv	ObjectStreamField(String name, String signature, boolean unshared) Creates an ObjectStreamField representing a field with the given name, signature and unshared setting.
pack-priv	ObjectStreamField(Field field, boolean unshared, boolean showType) Creates an ObjectStreamField representing the given field with the specified unshared setting.

Method Summary

Modifier and Type	Method and Description
public int	compareTo(Object the object to be compared. obj) Implements java.lang.Comparable.compareTo. Compare this field with another `ObjectStreamField`.
pack-priv Field	getField() Returns field represented by this ObjectStreamField, or null if ObjectStreamField is not associated with an actual field.
public String	Returns: a `String` representing the name of the serializable field getName() Get the name of this field.
public int	Returns: the offset of this field getOffset() Offset of field within instance data.
pack-priv String	getSignature() Returns JVM type signature of field (similar to getTypeString, except that signature strings are returned for primitive fields as well).
public Class<?>	Returns: a `Class` object representing the type of the serializable field getType() Get the type of the field.
public char	Returns: the typecode of the serializable field getTypeCode() Returns character encoding of field type.
public String	Returns: null if this field has a primitive type. getTypeString() Return the JVM type signature.
public boolean	Returns: true if and only if this field corresponds to a primitive type isPrimitive() Return true if this field has a primitive type.
public boolean	Returns: `true` if this field is unshared isUnshared() Returns boolean value indicating whether or not the serializable field represented by this ObjectStreamField instance is unshared.
protected void	setOffset(int the offset of the field offset) Offset within instance data.
public String	toString() Overrides java.lang.Object.toString. Return a string that describes this field.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

field	back to summary
private final Field field corresponding reflective field object, if any

name	back to summary
private final String name field name

offset	back to summary
private int offset offset of field value in enclosing field group

signature	back to summary
private final String signature canonical JVM signature of field type, if given

type	back to summary
private final Class<?> type field type (Object.class if unknown non-primitive type)

typeSignature	back to summary
private String typeSignature lazily constructed signature for the type, if no explicit signature

unshared	back to summary
private final boolean unshared whether or not to (de)serialize field values as unshared

Constructor Detail

ObjectStreamField back to summary

ObjectStreamField	back to summary
public ObjectStreamField(String name, Class<?> type) Create a Serializable field with the specified type. This field should be documented with a `serialField` tag. Parameters name:String the name of the serializable field type:Class<?> the `Class` object of the serializable field

public ObjectStreamField(String name, Class<?> type)

Create a Serializable field with the specified type. This field should be documented with a serialField tag.

Parameters

name:String: the name of the serializable field
type:Class<?>: the Class object of the serializable field

ObjectStreamField	back to summary
public ObjectStreamField(String name, Class<?> type, boolean unshared) Creates an ObjectStreamField representing a serializable field with the given name and type. If unshared is false, values of the represented field are serialized and deserialized in the default manner--if the field is non-primitive, object values are serialized and deserialized as if they had been written and read by calls to writeObject and readObject. If unshared is true, values of the represented field are serialized and deserialized as if they had been written and read by calls to writeUnshared and readUnshared. Parameters name:String field name type:Class<?> field type unshared:boolean if false, write/read field values in the same manner as writeObject/readObject; if true, write/read in the same manner as writeUnshared/readUnshared Since 1.4

ObjectStreamField

back to summary

public ObjectStreamField(String name, Class<?> type, boolean unshared)

Creates an ObjectStreamField representing a serializable field with the given name and type. If unshared is false, values of the represented field are serialized and deserialized in the default manner--if the field is non-primitive, object values are serialized and deserialized as if they had been written and read by calls to writeObject and readObject. If unshared is true, values of the represented field are serialized and deserialized as if they had been written and read by calls to writeUnshared and readUnshared.

Parameters

name:String: field name
type:Class<?>: field type
unshared:boolean: if false, write/read field values in the same manner as writeObject/readObject; if true, write/read in the same manner as writeUnshared/readUnshared

Since

1.4

ObjectStreamField	back to summary
pack-priv ObjectStreamField(String name, String signature, boolean unshared) Creates an ObjectStreamField representing a field with the given name, signature and unshared setting.

ObjectStreamField	back to summary
pack-priv ObjectStreamField(Field field, boolean unshared, boolean showType) Creates an ObjectStreamField representing the given field with the specified unshared setting. For compatibility with the behavior of earlier serialization implementations, a "showType" parameter is necessary to govern whether or not a getType() call on this ObjectStreamField (if non-primitive) will return Object.class (as opposed to a more specific reference type).

ObjectStreamField

back to summary

pack-priv ObjectStreamField(Field field, boolean unshared, boolean showType)

Creates an ObjectStreamField representing the given field with the specified unshared setting. For compatibility with the behavior of earlier serialization implementations, a "showType" parameter is necessary to govern whether or not a getType() call on this ObjectStreamField (if non-primitive) will return Object.class (as opposed to a more specific reference type).

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(Object obj) Implements java.lang.Comparable.compareTo. Compare this field with another `ObjectStreamField`. Return -1 if this is smaller, 0 if equal, 1 if greater. Types that are primitives are "smaller" than object types. If equal, the field names are compared. Parameters obj:Object Doc from java.lang.Comparable.compareTo. the object to be compared. Returns:int Doc from java.lang.Comparable.compareTo. a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

public int compareTo(Object obj)

Implements java.lang.Comparable.compareTo.

Compare this field with another ObjectStreamField. Return -1 if this is smaller, 0 if equal, 1 if greater. Types that are primitives are "smaller" than object types. If equal, the field names are compared.

Parameters

obj:Object

Doc from java.lang.Comparable.compareTo.

the object to be compared.

Returns:int

Doc from java.lang.Comparable.compareTo.

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

getField	back to summary
pack-priv Field getField() Returns field represented by this ObjectStreamField, or null if ObjectStreamField is not associated with an actual field.

getName back to summary

getName	back to summary
public String getName() Get the name of this field. Returns:String a `String` representing the name of the serializable field

public String getName()

Get the name of this field.

Returns:String: a String representing the name of the serializable field

getOffset back to summary

getOffset	back to summary
public int getOffset() Offset of field within instance data. Returns:int the offset of this field See Also `setOffset`

public int getOffset()

Offset of field within instance data.

Returns:int: the offset of this field
See Also: setOffset

getSignature	back to summary
pack-priv String getSignature() Returns JVM type signature of field (similar to getTypeString, except that signature strings are returned for primitive fields as well).

getType back to summary

getType	back to summary
public Class<?> getType() Get the type of the field. If the type is non-primitive and this `ObjectStreamField` was obtained from a deserialized `ObjectStreamClass` instance, then `Object.class` is returned. Otherwise, the `Class` object for the type of the field is returned. Returns:Class<?> a `Class` object representing the type of the serializable field Annotations @SuppressWarnings:removal @CallerSensitive

public Class<?> getType()

Get the type of the field. If the type is non-primitive and this ObjectStreamField was obtained from a deserialized ObjectStreamClass instance, then Object.class is returned. Otherwise, the Class object for the type of the field is returned.

Returns:Class<?>

a Class object representing the type of the serializable field

Annotations

@SuppressWarnings:removal
@CallerSensitive

getTypeCode	back to summary
public char getTypeCode() Returns character encoding of field type. The encoding is as follows: B byte C char D double F float I int J long L class or interface S short Z boolean [ array Returns:char the typecode of the serializable field

getTypeCode

back to summary

public char getTypeCode()

Returns character encoding of field type. The encoding is as follows:

B            byte
C            char
D            double
F            float
I            int
J            long
L            class or interface
S            short
Z            boolean
[            array

Returns:char: the typecode of the serializable field

getTypeString	back to summary
public String getTypeString() Return the JVM type signature. Returns:String null if this field has a primitive type.

getTypeString

back to summary

public String getTypeString()

Return the JVM type signature.

Returns:String: null if this field has a primitive type.

isPrimitive	back to summary
public boolean isPrimitive() Return true if this field has a primitive type. Returns:boolean true if and only if this field corresponds to a primitive type

isPrimitive

back to summary

public boolean isPrimitive()

Return true if this field has a primitive type.

Returns:boolean: true if and only if this field corresponds to a primitive type

isUnshared back to summary

isUnshared	back to summary
public boolean isUnshared() Returns boolean value indicating whether or not the serializable field represented by this ObjectStreamField instance is unshared. Returns:boolean `true` if this field is unshared Since 1.4

public boolean isUnshared()

Returns boolean value indicating whether or not the serializable field represented by this ObjectStreamField instance is unshared.

Returns:boolean: true if this field is unshared
Since: 1.4

setOffset back to summary

setOffset	back to summary
protected void setOffset(int offset) Offset within instance data. Parameters offset:int the offset of the field See Also `getOffset`

protected void setOffset(int offset)

Offset within instance data.

Parameters

offset:int: the offset of the field

See Also

getOffset

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Return a string that describes this field. Returns:String Doc from java.lang.Object.toString. a string representation of the object

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Return a string that describes this field.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

public Class ObjectStreamField

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail