Save This Page
Home » openjdk-7 » java » io » [javadoc | source]
java.io
public class: ObjectStreamField [javadoc | source]
java.lang.Object
   java.io.ObjectStreamField

All Implemented Interfaces:
    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.
Constructor:
 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 - the name of the serializable field
    type - the Class object of the serializable field
 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 - 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 -
 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. 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 from java.io.ObjectStreamField Summary:
compareTo,   getField,   getName,   getOffset,   getSignature,   getType,   getTypeCode,   getTypeString,   isPrimitive,   isUnshared,   setOffset,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.io.ObjectStreamField Detail:
 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.
 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. 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.
 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
    
 public String getTypeString() 
    Return the JVM type signature.
 public boolean isPrimitive() 
    Return true if this field has a primitive type.
 public 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.