| java.lang.Object
 java.io.ObjectStreamField
| ObjectStreamField | | public class ObjectStreamField implements Comparable(Code) | | A description of a Serializable field from a Serializable class.
An array of ObjectStreamFields is used to declare the Serializable
fields of a class.
author:
Mike Warres
author:
Roger Riggs
version:
1.38, 01/07/25
See Also: ObjectStreamClass
since:
1.2 |
| Constructor Summary | |
| public | ObjectStreamField(String name, Class type)
Create a Serializable field with the specified type.
This field should be documented with a serialField
tag. | | public | ObjectStreamField(String name, Class type, boolean unshared)
Creates an ObjectStreamField representing a serializable field with the
given name and type. | | | ObjectStreamField(String name, String signature, boolean unshared)
Creates an ObjectStreamField representing a field with the given name,
signature and unshared setting. | | | ObjectStreamField(Field field, boolean unshared, boolean showType)
Creates an ObjectStreamField representing the given field with the
specified unshared setting. |
| Method Summary | |
| public int | compareTo(Object obj)
Compare this field with another ObjectStreamField. | | Field | getField()
Returns field represented by this ObjectStreamField, or null if
ObjectStreamField is not associated with an actual field. | | public String | getName()
Get the name of this field. | | public int | getOffset()
Offset of field within instance data. | | String | getSignature()
Returns JVM type signature of field (similar to getTypeString, except
that signature strings are returned for primitive fields as well). | | public Class | getType()
Get the type of the field. | | public char | getTypeCode()
Returns character encoding of field type. | | public String | getTypeString()
Return the JVM type signature. | | public boolean | isPrimitive()
Return true if this field has a primitive type. | | boolean | isUnshared()
Returns boolean value indicating whether or not the serializable field
represented by this ObjectStreamField instance is unshared. | | protected void | setOffset(int offset)
Offset within instance data. | | public String | toString()
Return a string that describes this field. |
| ObjectStreamField | | public ObjectStreamField(String name, Class type)(Code) | | Create a Serializable field with the specified type.
This field should be documented with a serialField
tag.
Parameters:
n - the name of the serializable field
Parameters:
clazz - the Class object of the serializable field |
| ObjectStreamField | | public ObjectStreamField(String name, Class type, boolean unshared)(Code) | | 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 - field name
Parameters:
type - field type
Parameters:
unshared - if false, write/read field values in the same manneras writeObject/readObject; if true, write/read in the samemanner as writeUnshared/readUnshared |
| ObjectStreamField | | ObjectStreamField(String name, String signature, boolean unshared)(Code) | | Creates an ObjectStreamField representing a field with the given name,
signature and unshared setting.
|
| ObjectStreamField | | ObjectStreamField(Field field, boolean unshared, boolean showType)(Code) | | 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).
|
| compareTo | | public int compareTo(Object obj)(Code) | | 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.
|
| getField | | Field getField()(Code) | | Returns field represented by this ObjectStreamField, or null if
ObjectStreamField is not associated with an actual field.
|
| getName | | public String getName()(Code) | | Get the name of this field.
a String representing the name of the serializablefield |
| getSignature | | String getSignature()(Code) | | Returns JVM type signature of field (similar to getTypeString, except
that signature strings are returned for primitive fields as well).
|
| getType | | public Class getType()(Code) | | Get the type of the field.
the Class object of the serializable field |
| getTypeCode | | public char getTypeCode()(Code) | | 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
the typecode of the serializable field |
| getTypeString | | public String getTypeString()(Code) | | Return the JVM type signature.
null if this field has a primitive type. |
| isPrimitive | | public boolean isPrimitive()(Code) | | Return true if this field has a primitive type.
true if and only if this field corresponds to a primitive type |
| isUnshared | | boolean isUnshared()(Code) | | Returns boolean value indicating whether or not the serializable field
represented by this ObjectStreamField instance is unshared.
|
| toString | | public String toString()(Code) | | Return a string that describes this field.
|
|
|