Java Platform 1.2

java.io
Class ObjectStreamField

java.lang.Object
  |
  +--java.io.ObjectStreamField

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:
ObjectStreamClass

Constructor Summary
ObjectStreamField(String n, Class clazz)
          Create a Serializable field with the specified type.
 
Method Summary
 int compareTo(Object o)
          Compare this field with another ObjectStreamField.
 String getName()
          Get the name of this field.
 int getOffset()
          Offset of field within instance data.
 Class getType()
          Get the type of the field.
 char getTypeCode()
          Returns character encoding of field type.
 String getTypeString()
          Return the JVM type signature.
 boolean isPrimitive()
          Return true if this field has a primitive type.
protected  void setOffset(int offset)
          Offset within instance data.
 String toString()
          Return a string that describes this field.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ObjectStreamField

public ObjectStreamField(String n,
                         Class clazz)
Create a Serializable field with the specified type. This field should be documented with a serialField tag.
Method Detail

getName

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

getType

public Class getType()
Get the type of the 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
 

getTypeString

public String getTypeString()
Return the JVM type signature.

getOffset

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

setOffset

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

isPrimitive

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

compareTo

public int compareTo(Object o)
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.
Specified by:
compareTo in interface Comparable

toString

public String toString()
Return a string that describes this field.
Overrides:
toString in class Object

Java Platform 1.2

Submit a bug or feature Version 1.2 of Java Platform API Specification
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.