|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class ObjectStreamField
java.io.ObjectStreamField
All Implemented Interfaces:
public class ObjectStreamField
A description of a Serializable field from a Serializable class. An array
of ObjectStreamFields is used to declare the Serializable fields of a class.
Since:
1.2
Author:
Mike Warres, Roger Riggs
See Also:
Constructor Summary |
Create a Serializable field with the specified type.
|
Creates an ObjectStreamField representing a serializable field with the
given name and type.
|
Method Summary |
int |
Compare this field with another ObjectStreamField.
|
|
Get the name of this field.
|
int |
Offset of field within instance data.
|
|
Get the type of the field.
|
char |
Returns character encoding of field type.
|
|
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 |
Offset within instance data.
|
|
Return a string that describes this field.
|
Methods inherited from class java.lang. Object |
|
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
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
Get the name of this field.
Returns:
a String representing the name of the serializable
field
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.
Returns:
a Class object representing the type of the
serializable field
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
Return the JVM type signature.
Returns:
null if this field has a primitive type.
Offset of field within instance data.
Returns:
the offset of this field
See Also:
protected void setOffset |
(int offset) |
Offset within instance data.
Parameters:
offset - the offset of the field
See Also:
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
public boolean isUnshared |
() |
Returns boolean value indicating whether or not the serializable field
represented by this ObjectStreamField instance is unshared.
Returns:
true if this field is unshared
Since:
1.4
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:
Parameters:
obj - the object to be compared.
Returns:
a negative integer, zero, or a positive integer as this object
is less than, equal to, or greater than the specified object.
Return a string that describes this field.
Overrides:
Returns:
a string representation of the object.
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz