org.apache.river.api.io

Class AtomicSerial.GetArg

java.lang.Object

java.io.ObjectInputStream.GetField

org.apache.river.api.io.AtomicSerial.GetArg

All Implemented Interfaces:

ObjectStreamContext

Enclosing class:

AtomicSerial

public abstract static class AtomicSerial.GetArg
extends ObjectInputStream.GetField
implements ObjectStreamContext

GetArg is the single argument to AtomicSerial's constructor

Author:

peter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GetArg() Not intended for general construction, however may be extended by an ObjectInput implementation or for testing purposes.

Method Summary

Modifier and Type	Method and Description
abstract <T> T	get(String name, T val, Class<T> type) Get the value of the named Object field from the persistent field.
abstract AtomicSerial.ReadObject	getReader() If an AtomicSerial implementation annotates a static method that returns a Reader instance, with AtomicSerial.ReadInput, then the stream will provide the ReadObject access to the stream at a time that suits the stream.
abstract Class[]	serialClasses() Provides access to stream classes that belong to the Object under construction, ordered from superclass to child class.
abstract AtomicSerial.GetArg	validateInvariants(String[] fields, Class[] types, boolean[] nonNull)

Methods inherited from class java.io.ObjectInputStream.GetField

defaulted, get, get, get, get, get, get, get, get, get, getObjectStreamClass

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.jini.io.ObjectStreamContext

getObjectStreamContext

Constructor Detail

GetArg

protected GetArg()

Not intended for general construction, however may be extended by an ObjectInput implementation or for testing purposes.

Throws:

SecurityException - if caller doesn't have permission java.io.SerializablePermission "enableSubclassImplementation";

Method Detail

serialClasses

public abstract Class[] serialClasses()

Provides access to stream classes that belong to the Object under construction, ordered from superclass to child class.

Returns:

stream classes that belong to the object currently being de-serialized.

getReader

public abstract AtomicSerial.ReadObject getReader()

If an AtomicSerial implementation annotates a static method that returns a Reader instance, with AtomicSerial.ReadInput, then the stream will provide the ReadObject access to the stream at a time that suits the stream. This method provides a way for an object under construction to retrieve information from the stream. This is provided to retain compatibility with writeObject methods that write directly to the stream.

Returns:

ReadObject instance provided by static class method after it has read from the stream, or null.

get

public abstract <T> T get(String name,
                          T val,
                          Class<T> type)
                   throws IOException

Get the value of the named Object field from the persistent field. Convenience method to avoid type casts, that also performs a type check.

Instances of java.util.Collection will be replaced in the stream by a safe limited functionality immutable Collection instance that must be passed to a collection instance constructor. It is advisable to pass a Collections empty collection instance for the val parameter, to prevent a NullPointerException, in this case.

Type Parameters:

T - Type of object, note if T is an instance of Class<? extends SomeClass> the you must validate it, as this method can't.

Parameters:

name - the name of the field

val - the default value to use if name does not have a value

type - check to be performed, prior to returning.

Returns:

the value of the named Object field

Throws:

IOException - if there are I/O errors while reading from the underlying InputStream

IllegalArgumentException - if type of name is not serializable or if the field type is incorrect

InvalidObjectException - containing a ClassCastException cause if object to be returned is not an instance of type.

NullPointerException - if type is null.

validateInvariants

public abstract AtomicSerial.GetArg validateInvariants(String[] fields,
                                                       Class[] types,
                                                       boolean[] nonNull)
                                                throws IOException

Throws:

IOException