java.io.ObjectStreamField

public class java.io

ObjectStreamField

Java SE 6

Implements: Comparable

A description of a Serializable field from a Serializable class. An array of ObjectStreamFields is used to declare the Serializable fields of a class.

version	1.47, 06/04/07
since	1.2
See also	java.io.ObjectStreamClass

Constructors

public

ObjectStreamField(String name, Class type) Details

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

name	the name of the serializable field
type	the `Class` object of the serializable field

public

ObjectStreamField(String name, Class type, boolean unshared) Details

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.

name	field name
type	field type
unshared	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

Methods

public int

compareTo(Object obj)
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.

public String

toString()
Return a string that describes this field.

Properties

public String

getName() Details

Get the name of this field.

return a String representing the name of the serializable field

protected void

setOffset(int offset) Details

Offset within instance data.

offset	the offset of the field
See also	getOffset

public int

getOffset() Details

Offset of field within instance data.

return	the offset of this field
See also	setOffset

public boolean

isPrimitive() Details

Return true if this field has a primitive type.

return

true if and only if this field corresponds to a primitive type

public Class

getType() Details

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.

return a Class object representing the type of the serializable field

public char

getTypeCode() Details

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

return

the typecode of the serializable field

public String

getTypeString() Details

Return the JVM type signature.

return

null if this field has a primitive type.

public boolean

isUnshared() Details

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

since

1.4

About DocWeb · Bundles · Export · Export All

Top 10 · Statistics · Login

About Sun · Contact · Privacy · Terms of Use · Trademarks

Java SE 6