This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.io
class ObjectStreamField

java.lang.Object extended by java.io.ObjectStreamField
All Implemented Interfaces:
Comparable

public class ObjectStreamField
extends Object
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.

See Also (auto-generated):

Class

ObjectOutputStream

ObjectStreamClass


Constructor Summary

          Create a Serializable field with the specified type.
ObjectStreamField(String name, Class type, boolean unshared)

          Creates an ObjectStreamField representing a serializable field with the given name and type.
 
Method Summary
 int

          Compare this field with another ObjectStreamField.
 String

          Get the name of this field.
 int

          Offset of field within instance data.
 Class

          Get the type of the field.
 char

          Returns character encoding of field type.
 String

          Return the JVM type signature.
 boolean

          Return true if this field has a primitive type.
 boolean

          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.
 String

          Return a string that describes this field.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ObjectStreamField

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

ObjectStreamField

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
Method Detail

compareTo

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.

Parameters:
obj

getName

public String getName()
Get the name of this field.

Returns:
a String representing the name of the serializable field

getOffset

public int getOffset()
Offset of field within instance data.

Returns:
the offset of this field

getType

public Class getType()
Get the type of the field. If the type is non-primitive and this ObjectStreamField was obtained from a deserialized {@link ObjectStreamClass} instance, then Object.class is returned. Otherwise, the Class object for the type of the field is returned.

Returns:
a Class object representing the type of the serializable field

getTypeCode

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:
the typecode of the serializable field

getTypeString

public String getTypeString()
Return the JVM type signature.

Returns:
null if this field has a primitive type.

isPrimitive

public boolean isPrimitive()
Return true if this field has a primitive type.

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

isUnshared

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


setOffset

protected void setOffset(int offset)
Offset within instance data.

Parameters:
offset - the offset of the field

toString

public String toString()
Return a string that describes this field.

Overrides:
toString in class Object


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.