org.apache.ignite.internal.portable.api

Interface PortableReader

All Known Implementing Classes:

PortableReaderExImpl

public interface PortableReader

Reader for portable objects used in PortableMarshalAware implementations. Useful for the cases when user wants a fine-grained control over serialization.

Note that Ignite never writes full strings for field or type names. Instead, for performance reasons, Ignite writes integer hash codes for type and field names. It has been tested that hash code conflicts for the type names or the field names within the same type are virtually non-existent and, to gain performance, it is safe to work with hash codes. For the cases when hash codes for different types or fields actually do collide, Ignite provides PortableIdMapper which allows to override the automatically generated hash code IDs for the type and field names.

Method Summary

Methods

Modifier and Type	Method and Description
PortableRawReader	rawReader() Gets raw reader.
boolean	readBoolean(String fieldName)
boolean[]	readBooleanArray(String fieldName)
byte	readByte(String fieldName)
byte[]	readByteArray(String fieldName)
char	readChar(String fieldName)
char[]	readCharArray(String fieldName)
<T> Collection<T>	readCollection(String fieldName)
<T> Collection<T>	readCollection(String fieldName, Class<? extends Collection<T>> colCls)
Date	readDate(String fieldName)
Date[]	readDateArray(String fieldName)
BigDecimal	readDecimal(String fieldName)
BigDecimal[]	readDecimalArray(String fieldName)
double	readDouble(String fieldName)
double[]	readDoubleArray(String fieldName)
<T extends Enum<?>> T	readEnum(String fieldName)
<T extends Enum<?>> T[]	readEnumArray(String fieldName)
float	readFloat(String fieldName)
float[]	readFloatArray(String fieldName)
int	readInt(String fieldName)
int[]	readIntArray(String fieldName)
long	readLong(String fieldName)
long[]	readLongArray(String fieldName)
<K,V> Map<K,V>	readMap(String fieldName)
<K,V> Map<K,V>	readMap(String fieldName, Class<? extends Map<K,V>> mapCls)
<T> T	readObject(String fieldName)
Object[]	readObjectArray(String fieldName)
short	readShort(String fieldName)
short[]	readShortArray(String fieldName)
String	readString(String fieldName)
String[]	readStringArray(String fieldName)
Timestamp	readTimestamp(String fieldName)
UUID	readUuid(String fieldName)
UUID[]	readUuidArray(String fieldName)

Method Detail

readByte

byte readByte(String fieldName)
              throws PortableException

Parameters:

fieldName - Field name.

Returns:

Byte value.

Throws:

PortableException - In case of error.

readShort

short readShort(String fieldName)
                throws PortableException

Parameters:

fieldName - Field name.

Returns:

Short value.

Throws:

PortableException - In case of error.

readInt

int readInt(String fieldName)
            throws PortableException

Parameters:

fieldName - Field name.

Returns:

Integer value.

Throws:

PortableException - In case of error.

readLong

long readLong(String fieldName)
              throws PortableException

Parameters:

fieldName - Field name.

Returns:

Long value.

Throws:

PortableException - In case of error.

readFloat

float readFloat(String fieldName)
                throws PortableException

Parameters:

fieldName - Field name.

Returns:

Float value.

Throws:

PortableException - In case of error.

readDouble

double readDouble(String fieldName)
                  throws PortableException

Parameters:

fieldName - Field name.

Returns:

Double value.

Throws:

PortableException - In case of error.

readChar

char readChar(String fieldName)
              throws PortableException

Parameters:

fieldName - Field name.

Returns:

Char value.

Throws:

PortableException - In case of error.

readBoolean

boolean readBoolean(String fieldName)
                    throws PortableException

Parameters:

fieldName - Field name.

Returns:

Boolean value.

Throws:

PortableException - In case of error.

readDecimal

@Nullable
BigDecimal readDecimal(String fieldName)
                       throws PortableException

Parameters:

fieldName - Field name.

Returns:

Decimal value.

Throws:

PortableException - In case of error.

readString

@Nullable
String readString(String fieldName)
                  throws PortableException

Parameters:

fieldName - Field name.

Returns:

String value.

Throws:

PortableException - In case of error.

readUuid

@Nullable
UUID readUuid(String fieldName)
              throws PortableException

Parameters:

fieldName - Field name.

Returns:

UUID.

Throws:

PortableException - In case of error.

readDate

@Nullable
Date readDate(String fieldName)
              throws PortableException

Parameters:

fieldName - Field name.

Returns:

Date.

Throws:

PortableException - In case of error.

readTimestamp

@Nullable
Timestamp readTimestamp(String fieldName)
                        throws PortableException

Parameters:

fieldName - Field name.

Returns:

Timestamp.

Throws:

PortableException - In case of error.

readObject

@Nullable
<T> T readObject(String fieldName)
             throws PortableException

Parameters:

fieldName - Field name.

Returns:

Object.

Throws:

PortableException - In case of error.

readByteArray

@Nullable
byte[] readByteArray(String fieldName)
                     throws PortableException

Parameters:

fieldName - Field name.

Returns:

Byte array.

Throws:

PortableException - In case of error.

readShortArray

@Nullable
short[] readShortArray(String fieldName)
                       throws PortableException

Parameters:

fieldName - Field name.

Returns:

Short array.

Throws:

PortableException - In case of error.

readIntArray

@Nullable
int[] readIntArray(String fieldName)
                   throws PortableException

Parameters:

fieldName - Field name.

Returns:

Integer array.

Throws:

PortableException - In case of error.

readLongArray

@Nullable
long[] readLongArray(String fieldName)
                     throws PortableException

Parameters:

fieldName - Field name.

Returns:

Long array.

Throws:

PortableException - In case of error.

readFloatArray

@Nullable
float[] readFloatArray(String fieldName)
                       throws PortableException

Parameters:

fieldName - Field name.

Returns:

Float array.

Throws:

PortableException - In case of error.

readDoubleArray

@Nullable
double[] readDoubleArray(String fieldName)
                         throws PortableException

Parameters:

fieldName - Field name.

Returns:

Byte array.

Throws:

PortableException - In case of error.

readCharArray

@Nullable
char[] readCharArray(String fieldName)
                     throws PortableException

Parameters:

fieldName - Field name.

Returns:

Char array.

Throws:

PortableException - In case of error.

readBooleanArray

@Nullable
boolean[] readBooleanArray(String fieldName)
                           throws PortableException

Parameters:

fieldName - Field name.

Returns:

Boolean array.

Throws:

PortableException - In case of error.

readDecimalArray

@Nullable
BigDecimal[] readDecimalArray(String fieldName)
                              throws PortableException

Parameters:

fieldName - Field name.

Returns:

Decimal array.

Throws:

PortableException - In case of error.

readStringArray

@Nullable
String[] readStringArray(String fieldName)
                         throws PortableException

Parameters:

fieldName - Field name.

Returns:

String array.

Throws:

PortableException - In case of error.

readUuidArray

@Nullable
UUID[] readUuidArray(String fieldName)
                     throws PortableException

Parameters:

fieldName - Field name.

Returns:

UUID array.

Throws:

PortableException - In case of error.

readDateArray

@Nullable
Date[] readDateArray(String fieldName)
                     throws PortableException

Parameters:

fieldName - Field name.

Returns:

Date array.

Throws:

PortableException - In case of error.

readObjectArray

@Nullable
Object[] readObjectArray(String fieldName)
                         throws PortableException

Parameters:

fieldName - Field name.

Returns:

Object array.

Throws:

PortableException - In case of error.

readCollection

@Nullable
<T> Collection<T> readCollection(String fieldName)
                             throws PortableException

Parameters:

fieldName - Field name.

Returns:

Collection.

Throws:

PortableException - In case of error.

readCollection

@Nullable
<T> Collection<T> readCollection(String fieldName,
                                        Class<? extends Collection<T>> colCls)
                             throws PortableException

Parameters:

fieldName - Field name.

colCls - Collection class.

Returns:

Collection.

Throws:

PortableException - In case of error.

readMap

@Nullable
<K,V> Map<K,V> readMap(String fieldName)
                 throws PortableException

Parameters:

fieldName - Field name.

Returns:

Map.

Throws:

PortableException - In case of error.

readMap

@Nullable
<K,V> Map<K,V> readMap(String fieldName,
                              Class<? extends Map<K,V>> mapCls)
                 throws PortableException

Parameters:

fieldName - Field name.

mapCls - Map class.

Returns:

Map.

Throws:

PortableException - In case of error.

readEnum

@Nullable
<T extends Enum<?>> T readEnum(String fieldName)
                        throws PortableException

Parameters:

fieldName - Field name.

Returns:

Value.

Throws:

PortableException - In case of error.

readEnumArray

@Nullable
<T extends Enum<?>> T[] readEnumArray(String fieldName)
                               throws PortableException

Parameters:

fieldName - Field name.

Returns:

Value.

Throws:

PortableException - In case of error.

rawReader

PortableRawReader rawReader()

Gets raw reader. Raw reader does not use field name hash codes, therefore, making the format even more compact. However, if the raw reader is used, dynamic structure changes to the portable objects are not supported.

Returns:

Raw reader.