ObjectOutputStream.PutField

AI-generated Key Takeaways

• ObjectOutputStream.PutField provides programmatic access to persistent fields for writing to ObjectOutput.

• It offers methods to set values for various data types like int, float, Object, etc., associated with field names.

• The write method is deprecated due to potential data corruption; use ObjectOutputStream.writeFields() instead.

• Incorrect field names or types in put methods will result in IllegalArgumentException.

public static abstract class ObjectOutputStream.PutField extends Object

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

Public Constructor Summary

PutField()

Public Method Summary

abstract void	put(String name, float val) Put the value of the named float 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, 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, byte val) Put the value of the named byte 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	put(String name, char val) Put the value of the named char field into the persistent field.
abstract void	put(String name, boolean val) Put the value of the named boolean field into the persistent field.
abstract void	write(ObjectOutput out) This method is deprecated. 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.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Public Constructors

public PutField ()

Public Methods

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

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

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

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

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

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

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

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

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

public abstract void write (ObjectOutput out)

This method is deprecated.
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