Class ObjectOutputStream.PutField

java.lang.Object

java.io.ObjectOutputStream.PutField

Enclosing class:

ObjectOutputStream

public abstract static class ObjectOutputStream.PutField
extends Object

Provide programmatic access to the persistent fields to be written to ObjectOutput.

Since:

1.2

Constructor Summary

Constructors

Constructor	Description
PutField()	Constructor for subclasses to call.

Method Summary

Modifier and Type	Method	Description
abstract void	put(String name, boolean val)	Put the value of the named boolean field into the persistent field.
abstract void	put(String name, byte val)	Put the value of the named byte field into the persistent field.
abstract void	put(String name, char val)	Put the value of the named char field into the persistent field.
abstract void	put(String name, double val)	Put the value of the named double field into the persistent field.
abstract void	put(String name, float val)	Put the value of the named float field into the persistent field.
abstract void	put(String name, int val)	Put the value of the named int field into the persistent field.
abstract void	put(String name, long val)	Put the value of the named long field into the persistent field.
abstract void	put(String name, short val)	Put the value of the named short field into the persistent field.
abstract void	put(String name, Object val)	Put the value of the named Object field into the persistent field.
abstract void	write(ObjectOutput out)	Deprecated, for removal: This API element is subject to removal in a future version. This method does not write the values contained by this PutField object in a proper format, and may result in corruption of the serialization stream.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Constructor Details

PutField

public PutField()

Constructor for subclasses to call.

Method Details

put

public abstract void put(String name,
 boolean val)

Put the value of the named boolean field into the persistent field.

Parameters:

name - the name of the serializable field

val - the value to assign to the field

Throws:

IllegalArgumentException - if name does not match the name of a serializable field for the class whose fields are being written, or if the type of the named field is not boolean

put

public abstract void put(String name,
 byte val)

Put the value of the named byte field into the persistent field.

Parameters:

name - the name of the serializable field

val - the value to assign to the field

Throws:

IllegalArgumentException - if name does not match the name of a serializable field for the class whose fields are being written, or if the type of the named field is not byte

put

public abstract void put(String name,
 char val)

Put the value of the named char field into the persistent field.

Parameters:

name - the name of the serializable field

val - the value to assign to the field

Throws:

IllegalArgumentException - if name does not match the name of a serializable field for the class whose fields are being written, or if the type of the named field is not char

put

public abstract void put(String name,
 short val)

Put the value of the named short field into the persistent field.

Parameters:

name - the name of the serializable field

val - the value to assign to the field

Throws:

IllegalArgumentException - if name does not match the name of a serializable field for the class whose fields are being written, or if the type of the named field is not short

put

public abstract void put(String name,
 int val)

Put the value of the named int field into the persistent field.

Parameters:

name - the name of the serializable field

val - the value to assign to the field

Throws:

IllegalArgumentException - if name does not match the name of a serializable field for the class whose fields are being written, or if the type of the named field is not int

put

public abstract void put(String name,
 long val)

Put the value of the named long field into the persistent field.

Parameters:

name - the name of the serializable field

val - the value to assign to the field

Throws:

IllegalArgumentException - if name does not match the name of a serializable field for the class whose fields are being written, or if the type of the named field is not long

put

public abstract void put(String name,
 float val)

Put the value of the named float field into the persistent field.

Parameters:

name - the name of the serializable field

val - the value to assign to the field

Throws:

IllegalArgumentException - if name does not match the name of a serializable field for the class whose fields are being written, or if the type of the named field is not float

put

public abstract void put(String name,
 double val)

Put the value of the named double field into the persistent field.

Parameters:

name - the name of the serializable field

val - the value to assign to the field

Throws:

IllegalArgumentException - if name does not match the name of a serializable field for the class whose fields are being written, or if the type of the named field is not double

put

public abstract void put(String name,
 Object val)

Put the value of the named Object field into the persistent field.

Parameters:

name - the name of the serializable field

val - the value to assign to the field (which may be null)

Throws:

IllegalArgumentException - if name does not match the name of a serializable field for the class whose fields are being written, or if the type of the named field is not a reference type

write

@Deprecated(forRemoval=true,
            since="1.4")
public abstract void write(ObjectOutput out)
                    throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

This method does not write the values contained by this PutField object in a proper format, and may result in corruption of the serialization stream. The correct way to write PutField data is by calling the ObjectOutputStream.writeFields() method.

Write the data and fields to the specified ObjectOutput stream, which must be the same stream that produced this PutField object.

Parameters:

out - the stream to write the data and fields to

Throws:

IOException - if I/O errors occur while writing to the underlying stream

IllegalArgumentException - if the specified stream is not the same stream that produced this PutField object