Package de.gsi.serializer

Interface IoSerialiser

All Known Implementing Classes:

BinarySerialiser, CmwLightSerialiser, JsonSerialiser

public interface IoSerialiser

Method Summary

Modifier and Type	Method	Description
ProtocolInfo	checkHeaderInfo()	Reads and checks protocol header information.
int[]	getArraySizeDescriptor()
boolean	getBoolean()
default boolean[]	getBooleanArray()
default boolean[]	getBooleanArray(boolean[] dst)
boolean[]	getBooleanArray(boolean[] dst, int length)
IoBuffer	getBuffer()
byte	getByte()
default byte[]	getByteArray()
default byte[]	getByteArray(byte[] dst)
byte[]	getByteArray(byte[] dst, int length)
char	getChar()
default char[]	getCharArray()
default char[]	getCharArray(char[] dst)
char[]	getCharArray(char[] dst, int length)
<E> java.util.Collection<E>	getCollection(java.util.Collection<E> collection)
<E> E	getCustomData(FieldSerialiser<E> serialiser)
double	getDouble()
default double[]	getDoubleArray()
default double[]	getDoubleArray(double[] dst)
double[]	getDoubleArray(double[] dst, int length)
<E extends java.lang.Enum<E>> java.lang.Enum<E>	getEnum(java.lang.Enum<E> enumeration)
java.lang.String	getEnumTypeList()
WireDataFieldDescription	getFieldHeader()
float	getFloat()
default float[]	getFloatArray()
default float[]	getFloatArray(float[] dst)
float[]	getFloatArray(float[] dst, int length)
int	getInt()
default int[]	getIntArray()
default int[]	getIntArray(int[] dst)
int[]	getIntArray(int[] dst, int length)
<E> java.util.List<E>	getList(java.util.List<E> collection)
long	getLong()
default long[]	getLongArray()
default long[]	getLongArray(long[] dst)
long[]	getLongArray(long[] dst, int length)
<K,V,E> java.util.Map<K,V>	getMap(java.util.Map<K,V> map)
<E> java.util.Queue<E>	getQueue(java.util.Queue<E> collection)
java.util.function.BiFunction<java.lang.reflect.Type,java.lang.reflect.Type[],FieldSerialiser<java.lang.Object>>	getSerialiserLookupFunction()
<E> java.util.Set<E>	getSet(java.util.Set<E> collection)
short	getShort()
default short[]	getShortArray()
default short[]	getShortArray(short[] dst)
short[]	getShortArray(short[] dst, int length)
java.lang.String	getString()
default java.lang.String[]	getStringArray()
default java.lang.String[]	getStringArray(java.lang.String[] dst)
java.lang.String[]	getStringArray(java.lang.String[] dst, int length)
java.lang.String	getStringISO8859()
boolean	isPutFieldMetaData()
WireDataFieldDescription	parseIoStream(boolean readHeader)
void	put(FieldDescription fieldDescription, boolean value)
default void	put(FieldDescription fieldDescription, boolean[] src)
void	put(FieldDescription fieldDescription, boolean[] values, int n)
void	put(FieldDescription fieldDescription, boolean[] values, int[] dims)
void	put(FieldDescription fieldDescription, byte value)
default void	put(FieldDescription fieldDescription, byte[] src)
void	put(FieldDescription fieldDescription, byte[] values, int n)
void	put(FieldDescription fieldDescription, byte[] values, int[] dims)
void	put(FieldDescription fieldDescription, char value)
default void	put(FieldDescription fieldDescription, char[] src)
void	put(FieldDescription fieldDescription, char[] values, int n)
void	put(FieldDescription fieldDescription, char[] values, int[] dims)
void	put(FieldDescription fieldDescription, double value)
default void	put(FieldDescription fieldDescription, double[] src)
void	put(FieldDescription fieldDescription, double[] values, int n)
void	put(FieldDescription fieldDescription, double[] values, int[] dims)
void	put(FieldDescription fieldDescription, float value)
default void	put(FieldDescription fieldDescription, float[] src)
void	put(FieldDescription fieldDescription, float[] values, int n)
void	put(FieldDescription fieldDescription, float[] values, int[] dims)
void	put(FieldDescription fieldDescription, int value)
default void	put(FieldDescription fieldDescription, int[] src)
void	put(FieldDescription fieldDescription, int[] values, int n)
void	put(FieldDescription fieldDescription, int[] values, int[] dims)
void	put(FieldDescription fieldDescription, long value)
default void	put(FieldDescription fieldDescription, long[] src)
void	put(FieldDescription fieldDescription, long[] values, int n)
void	put(FieldDescription fieldDescription, long[] values, int[] dims)
void	put(FieldDescription fieldDescription, short value)
default void	put(FieldDescription fieldDescription, short[] src)
void	put(FieldDescription fieldDescription, short[] values, int n)
void	put(FieldDescription fieldDescription, short[] values, int[] dims)
void	put(FieldDescription fieldDescription, java.lang.Enum<?> enumeration)
void	put(FieldDescription fieldDescription, java.lang.String string)
default void	put(FieldDescription fieldDescription, java.lang.String[] src)
void	put(FieldDescription fieldDescription, java.lang.String[] values, int n)
void	put(FieldDescription fieldDescription, java.lang.String[] values, int[] dims)
<E> void	put(FieldDescription fieldDescription, java.util.Collection<E> collection, java.lang.reflect.Type valueType)
<K,V,E> void	put(FieldDescription fieldDescription, java.util.Map<K,V> map, java.lang.reflect.Type keyType, java.lang.reflect.Type valueType)
void	put(java.lang.String fieldName, boolean value)
default void	put(java.lang.String fieldName, boolean[] src)
void	put(java.lang.String fieldName, boolean[] values, int n)
void	put(java.lang.String fieldName, boolean[] values, int[] dims)
void	put(java.lang.String fieldName, byte value)
default void	put(java.lang.String fieldName, byte[] src)
void	put(java.lang.String fieldName, byte[] values, int n)
void	put(java.lang.String fieldName, byte[] values, int[] dims)
void	put(java.lang.String fieldName, char value)
default void	put(java.lang.String fieldName, char[] src)
void	put(java.lang.String fieldName, char[] values, int n)
void	put(java.lang.String fieldName, char[] values, int[] dims)
void	put(java.lang.String fieldName, double value)
default void	put(java.lang.String fieldName, double[] src)
void	put(java.lang.String fieldName, double[] values, int n)
void	put(java.lang.String fieldName, double[] values, int[] dims)
void	put(java.lang.String fieldName, float value)
default void	put(java.lang.String fieldName, float[] src)
void	put(java.lang.String fieldName, float[] values, int n)
void	put(java.lang.String fieldName, float[] values, int[] dims)
void	put(java.lang.String fieldName, int value)
default void	put(java.lang.String fieldName, int[] src)
void	put(java.lang.String fieldName, int[] values, int n)
void	put(java.lang.String fieldName, int[] values, int[] dims)
void	put(java.lang.String fieldName, long value)
default void	put(java.lang.String fieldName, long[] src)
void	put(java.lang.String fieldName, long[] values, int n)
void	put(java.lang.String fieldName, long[] values, int[] dims)
void	put(java.lang.String fieldName, short value)
default void	put(java.lang.String fieldName, short[] src)
void	put(java.lang.String fieldName, short[] values, int n)
void	put(java.lang.String fieldName, short[] values, int[] dims)
void	put(java.lang.String fieldName, java.lang.Enum<?> enumeration)
void	put(java.lang.String fieldName, java.lang.String string)
default void	put(java.lang.String fieldName, java.lang.String[] src)
void	put(java.lang.String fieldName, java.lang.String[] values, int n)
void	put(java.lang.String fieldName, java.lang.String[] values, int[] dims)
<E> void	put(java.lang.String fieldName, java.util.Collection<E> collection, java.lang.reflect.Type valueType)
<K,V,E> void	put(java.lang.String fieldName, java.util.Map<K,V> map, java.lang.reflect.Type keyType, java.lang.reflect.Type valueType)
int	putArraySizeDescriptor(int n)
int	putArraySizeDescriptor(int[] dims)
<E> WireDataFieldDescription	putCustomData(FieldDescription fieldDescription, E obj, java.lang.Class<? extends E> type, FieldSerialiser<E> serialiser)
void	putEndMarker(FieldDescription fieldDescription)
WireDataFieldDescription	putFieldHeader(FieldDescription fieldDescription)
WireDataFieldDescription	putFieldHeader(java.lang.String fieldName, DataType dataType)
void	putHeaderInfo(FieldDescription... field)	Adds header and version information
void	putStartMarker(FieldDescription fieldDescription)
void	setBuffer(IoBuffer buffer)
void	setFieldSerialiserLookupFunction(java.util.function.BiFunction<java.lang.reflect.Type,java.lang.reflect.Type[],FieldSerialiser<java.lang.Object>> serialiserLookupFunction)
void	setPutFieldMetaData(boolean putFieldMetaData)
void	setQueryFieldName(java.lang.String fieldName, int dataStartPosition)
void	updateDataEndMarker(WireDataFieldDescription fieldHeader)

Method Detail

checkHeaderInfo

ProtocolInfo checkHeaderInfo()

Reads and checks protocol header information.

Returns:

ProtocolInfo info Object (extends FieldHeader)

Throws:

java.lang.IllegalStateException - in case the format is incompatible with this serialiser

setQueryFieldName

void setQueryFieldName(java.lang.String fieldName,
                       int dataStartPosition)

getArraySizeDescriptor

int[] getArraySizeDescriptor()

getBoolean

boolean getBoolean()

getBooleanArray

default boolean[] getBooleanArray()

getBooleanArray

default boolean[] getBooleanArray(boolean[] dst)

getBooleanArray

boolean[] getBooleanArray(boolean[] dst,
                          int length)

getBuffer

IoBuffer getBuffer()

setBuffer

void setBuffer(IoBuffer buffer)

getByte

byte getByte()

getByteArray

default byte[] getByteArray()

getByteArray

default byte[] getByteArray(byte[] dst)

getByteArray

byte[] getByteArray(byte[] dst,
                    int length)

getChar

char getChar()

getCharArray

default char[] getCharArray()

getCharArray

default char[] getCharArray(char[] dst)

getCharArray

char[] getCharArray(char[] dst,
                    int length)

getCollection

<E> java.util.Collection<E> getCollection(java.util.Collection<E> collection)

getCustomData

<E> E getCustomData(FieldSerialiser<E> serialiser)

getDouble

double getDouble()

getDoubleArray

default double[] getDoubleArray()

getDoubleArray

default double[] getDoubleArray(double[] dst)

getDoubleArray

double[] getDoubleArray(double[] dst,
                        int length)

getEnum

<E extends java.lang.Enum<E>> java.lang.Enum<E> getEnum(java.lang.Enum<E> enumeration)

getEnumTypeList

java.lang.String getEnumTypeList()

getFieldHeader

WireDataFieldDescription getFieldHeader()

getFloat

float getFloat()

getFloatArray

default float[] getFloatArray()

getFloatArray

default float[] getFloatArray(float[] dst)

getFloatArray

float[] getFloatArray(float[] dst,
                      int length)

getInt

int getInt()

getIntArray

default int[] getIntArray()

getIntArray

default int[] getIntArray(int[] dst)

getIntArray

int[] getIntArray(int[] dst,
                  int length)

getList

<E> java.util.List<E> getList(java.util.List<E> collection)

getLong

long getLong()

getLongArray

default long[] getLongArray()

getLongArray

default long[] getLongArray(long[] dst)

getLongArray

long[] getLongArray(long[] dst,
                    int length)

getMap

<K,V,E> java.util.Map<K,V> getMap(java.util.Map<K,V> map)

getQueue

<E> java.util.Queue<E> getQueue(java.util.Queue<E> collection)

getSet

<E> java.util.Set<E> getSet(java.util.Set<E> collection)

getShort

short getShort()

getShortArray

default short[] getShortArray()

getShortArray

default short[] getShortArray(short[] dst)

getShortArray

short[] getShortArray(short[] dst,
                      int length)

getString

java.lang.String getString()

getStringArray

default java.lang.String[] getStringArray()

getStringArray

default java.lang.String[] getStringArray(java.lang.String[] dst)

getStringArray

java.lang.String[] getStringArray(java.lang.String[] dst,
                                  int length)

getStringISO8859

java.lang.String getStringISO8859()

isPutFieldMetaData

boolean isPutFieldMetaData()

setPutFieldMetaData

void setPutFieldMetaData(boolean putFieldMetaData)

parseIoStream

WireDataFieldDescription parseIoStream(boolean readHeader)

put

<E> void put(FieldDescription fieldDescription,
             java.util.Collection<E> collection,
             java.lang.reflect.Type valueType)

put

void put(FieldDescription fieldDescription,
         java.lang.Enum<?> enumeration)

put

<K,V,E> void put(FieldDescription fieldDescription,
                             java.util.Map<K,V> map,
                             java.lang.reflect.Type keyType,
                             java.lang.reflect.Type valueType)

put

<E> void put(java.lang.String fieldName,
             java.util.Collection<E> collection,
             java.lang.reflect.Type valueType)

put

void put(java.lang.String fieldName,
         java.lang.Enum<?> enumeration)

put

<K,V,E> void put(java.lang.String fieldName,
                             java.util.Map<K,V> map,
                             java.lang.reflect.Type keyType,
                             java.lang.reflect.Type valueType)

put

default void put(FieldDescription fieldDescription,
                 boolean[] src)

put

default void put(FieldDescription fieldDescription,
                 byte[] src)

put

default void put(FieldDescription fieldDescription,
                 char[] src)

put

default void put(FieldDescription fieldDescription,
                 double[] src)

put

default void put(FieldDescription fieldDescription,
                 float[] src)

put

default void put(FieldDescription fieldDescription,
                 int[] src)

put

default void put(FieldDescription fieldDescription,
                 long[] src)

put

default void put(FieldDescription fieldDescription,
                 short[] src)

put

default void put(FieldDescription fieldDescription,
                 java.lang.String[] src)

put

void put(FieldDescription fieldDescription,
         boolean value)

put

void put(FieldDescription fieldDescription,
         boolean[] values,
         int n)

put

void put(FieldDescription fieldDescription,
         boolean[] values,
         int[] dims)

put

void put(FieldDescription fieldDescription,
         byte value)

put

void put(FieldDescription fieldDescription,
         byte[] values,
         int n)

put

void put(FieldDescription fieldDescription,
         byte[] values,
         int[] dims)

put

void put(FieldDescription fieldDescription,
         char value)

put

void put(FieldDescription fieldDescription,
         char[] values,
         int n)

put

void put(FieldDescription fieldDescription,
         char[] values,
         int[] dims)

put

void put(FieldDescription fieldDescription,
         double value)

put

void put(FieldDescription fieldDescription,
         double[] values,
         int n)

put

void put(FieldDescription fieldDescription,
         double[] values,
         int[] dims)

put

void put(FieldDescription fieldDescription,
         float value)

put

void put(FieldDescription fieldDescription,
         float[] values,
         int n)

put

void put(FieldDescription fieldDescription,
         float[] values,
         int[] dims)

put

void put(FieldDescription fieldDescription,
         int value)

put

void put(FieldDescription fieldDescription,
         int[] values,
         int n)

put

void put(FieldDescription fieldDescription,
         int[] values,
         int[] dims)

put

void put(FieldDescription fieldDescription,
         long value)

put

void put(FieldDescription fieldDescription,
         long[] values,
         int n)

put

void put(FieldDescription fieldDescription,
         long[] values,
         int[] dims)

put

void put(FieldDescription fieldDescription,
         short value)

put

void put(FieldDescription fieldDescription,
         short[] values,
         int n)

put

void put(FieldDescription fieldDescription,
         short[] values,
         int[] dims)

put

void put(FieldDescription fieldDescription,
         java.lang.String string)

put

void put(FieldDescription fieldDescription,
         java.lang.String[] values,
         int n)

put

void put(FieldDescription fieldDescription,
         java.lang.String[] values,
         int[] dims)

put

default void put(java.lang.String fieldName,
                 boolean[] src)

put

default void put(java.lang.String fieldName,
                 byte[] src)

put

default void put(java.lang.String fieldName,
                 char[] src)

put

default void put(java.lang.String fieldName,
                 double[] src)

put

default void put(java.lang.String fieldName,
                 float[] src)

put

default void put(java.lang.String fieldName,
                 int[] src)

put

default void put(java.lang.String fieldName,
                 long[] src)

put

default void put(java.lang.String fieldName,
                 short[] src)

put

default void put(java.lang.String fieldName,
                 java.lang.String[] src)

put

void put(java.lang.String fieldName,
         boolean value)

put

void put(java.lang.String fieldName,
         boolean[] values,
         int n)

put

void put(java.lang.String fieldName,
         boolean[] values,
         int[] dims)

put

void put(java.lang.String fieldName,
         byte value)

put

void put(java.lang.String fieldName,
         byte[] values,
         int n)

put

void put(java.lang.String fieldName,
         byte[] values,
         int[] dims)

put

void put(java.lang.String fieldName,
         char value)

put

void put(java.lang.String fieldName,
         char[] values,
         int n)

put

void put(java.lang.String fieldName,
         char[] values,
         int[] dims)

put

void put(java.lang.String fieldName,
         double value)

put

void put(java.lang.String fieldName,
         double[] values,
         int n)

put

void put(java.lang.String fieldName,
         double[] values,
         int[] dims)

put

void put(java.lang.String fieldName,
         float value)

put

void put(java.lang.String fieldName,
         float[] values,
         int n)

put

void put(java.lang.String fieldName,
         float[] values,
         int[] dims)

put

void put(java.lang.String fieldName,
         int value)

put

void put(java.lang.String fieldName,
         int[] values,
         int n)

put

void put(java.lang.String fieldName,
         int[] values,
         int[] dims)

put

void put(java.lang.String fieldName,
         long value)

put

void put(java.lang.String fieldName,
         long[] values,
         int n)

put

void put(java.lang.String fieldName,
         long[] values,
         int[] dims)

put

void put(java.lang.String fieldName,
         short value)

put

void put(java.lang.String fieldName,
         short[] values,
         int n)

put

void put(java.lang.String fieldName,
         short[] values,
         int[] dims)

put

void put(java.lang.String fieldName,
         java.lang.String string)

put

void put(java.lang.String fieldName,
         java.lang.String[] values,
         int n)

put

void put(java.lang.String fieldName,
         java.lang.String[] values,
         int[] dims)

putArraySizeDescriptor

int putArraySizeDescriptor(int n)

putArraySizeDescriptor

int putArraySizeDescriptor(int[] dims)

putCustomData

<E> WireDataFieldDescription putCustomData(FieldDescription fieldDescription,
                                           E obj,
                                           java.lang.Class<? extends E> type,
                                           FieldSerialiser<E> serialiser)

putEndMarker

void putEndMarker(FieldDescription fieldDescription)

putFieldHeader

WireDataFieldDescription putFieldHeader(FieldDescription fieldDescription)

putFieldHeader

WireDataFieldDescription putFieldHeader(java.lang.String fieldName,
                                        DataType dataType)

putHeaderInfo

void putHeaderInfo(FieldDescription... field)

Adds header and version information

Parameters:

field - optional FieldDescription (ie. to allow to attach MetaData to the start/stop marker)

putStartMarker

void putStartMarker(FieldDescription fieldDescription)

updateDataEndMarker

void updateDataEndMarker(WireDataFieldDescription fieldHeader)

setFieldSerialiserLookupFunction

void setFieldSerialiserLookupFunction(java.util.function.BiFunction<java.lang.reflect.Type,java.lang.reflect.Type[],FieldSerialiser<java.lang.Object>> serialiserLookupFunction)

getSerialiserLookupFunction

java.util.function.BiFunction<java.lang.reflect.Type,java.lang.reflect.Type[],FieldSerialiser<java.lang.Object>> getSerialiserLookupFunction()