org.apache.isis.core.commons.encoding

Class FieldType<T>

java.lang.Object

org.apache.isis.core.commons.encoding.FieldType<T>

public abstract class FieldType<T>
extends Object

Typesafe writing and reading of fields, providing some level of integrity checking of encoded messages.

The write(DataOutputExtended, Object) writes out field type and then the data for that field type. The field type is represented by this enumberation, with the index being what is written to the stream (hence of type byte to keep small).

Conversely, the read(DataInputExtended) reads the field type and then the data for that field type.

Field Summary

Fields

Modifier and Type	Field and Description
static FieldType<Boolean>	BOOLEAN
static FieldType<boolean[]>	BOOLEAN_ARRAY
static FieldType<Byte>	BYTE
static FieldType<byte[]>	BYTE_ARRAY
static FieldType<Character>	CHAR
static FieldType<char[]>	CHAR_ARRAY
static FieldType<Double>	DOUBLE
static FieldType<double[]>	DOUBLE_ARRAY
static FieldType<Encodable>	ENCODABLE
static FieldType<Encodable[]>	ENCODABLE_ARRAY
static FieldType<Float>	FLOAT
static FieldType<float[]>	FLOAT_ARRAY
static FieldType<Integer>	INTEGER
static FieldType<int[]>	INTEGER_ARRAY
static FieldType<Long>	LONG
static FieldType<long[]>	LONG_ARRAY
static FieldType<Serializable>	SERIALIZABLE
static FieldType<Serializable[]>	SERIALIZABLE_ARRAY
static FieldType<Short>	SHORT
static FieldType<short[]>	SHORT_ARRAY
static FieldType<String>	STRING
static FieldType<String[]>	STRING_ARRAY
static FieldType<Integer>	UNSIGNED_BYTE
static FieldType<Integer>	UNSIGNED_SHORT

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checksStream() Whether this implementation checks ordering in the stream.
protected T	doRead(DataInputExtended input)
protected <Q> Q[]	doReadArray(DataInputExtended input, Class<Q> elementType)
protected abstract void	doWrite(DataOutputExtended output, T value)
static FieldType<?>	get(byte idx)
Class<T>	getCls()
byte	getIdx()
T	read(DataInputExtended input)
<Q> Q[]	readArray(DataInputExtended input, Class<Q> elementType)
String	toString()
void	write(DataOutputExtended output, T value)

Methods inherited from class java.lang.Object

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

Field Detail

BOOLEAN

public static FieldType<Boolean> BOOLEAN

BOOLEAN_ARRAY

public static FieldType<boolean[]> BOOLEAN_ARRAY

BYTE

public static FieldType<Byte> BYTE

BYTE_ARRAY

public static FieldType<byte[]> BYTE_ARRAY

SHORT

public static FieldType<Short> SHORT

SHORT_ARRAY

public static FieldType<short[]> SHORT_ARRAY

INTEGER

public static FieldType<Integer> INTEGER

UNSIGNED_BYTE

public static FieldType<Integer> UNSIGNED_BYTE

UNSIGNED_SHORT

public static FieldType<Integer> UNSIGNED_SHORT

INTEGER_ARRAY

public static FieldType<int[]> INTEGER_ARRAY

LONG

public static FieldType<Long> LONG

LONG_ARRAY

public static FieldType<long[]> LONG_ARRAY

CHAR

public static FieldType<Character> CHAR

CHAR_ARRAY

public static FieldType<char[]> CHAR_ARRAY

FLOAT

public static FieldType<Float> FLOAT

FLOAT_ARRAY

public static FieldType<float[]> FLOAT_ARRAY

DOUBLE

public static FieldType<Double> DOUBLE

DOUBLE_ARRAY

public static FieldType<double[]> DOUBLE_ARRAY

STRING

public static FieldType<String> STRING

STRING_ARRAY

public static FieldType<String[]> STRING_ARRAY

ENCODABLE

public static FieldType<Encodable> ENCODABLE

ENCODABLE_ARRAY

public static FieldType<Encodable[]> ENCODABLE_ARRAY

SERIALIZABLE

public static FieldType<Serializable> SERIALIZABLE

SERIALIZABLE_ARRAY

public static FieldType<Serializable[]> SERIALIZABLE_ARRAY

Method Detail

get

public static FieldType<?> get(byte idx)

getIdx

public byte getIdx()

getCls

public Class<T> getCls()

checksStream

protected boolean checksStream()

Whether this implementation checks ordering in the stream.

Broadly, the type safe ones do, the Encodable and Serializable ones do not.

read

public final T read(DataInputExtended input)
             throws IOException

Throws:

IOException

readArray

public final <Q> Q[] readArray(DataInputExtended input,
                Class<Q> elementType)
                    throws IOException

Throws:

IOException

write

public final void write(DataOutputExtended output,
         T value)
                 throws IOException

Throws:

IOException

doRead

protected T doRead(DataInputExtended input)
            throws IOException

Throws:

IOException

doReadArray

protected <Q> Q[] doReadArray(DataInputExtended input,
                  Class<Q> elementType)
                   throws IOException

Throws:

IOException

doWrite

protected abstract void doWrite(DataOutputExtended output,
           T value)
                         throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object