com.hazelcast.nio.serialization.compact

Interface CompactReader

@Beta
public interface CompactReader

Provides means of reading compact serialized fields from the binary data.

Read operations might throw HazelcastSerializationException when a field with the given name is not found or there is a type mismatch. On such occasions, one might provide default values to the read methods to return it in case of the failure scenarios described above. Providing default values might be especially useful, if the class might evolve in future, either by adding or removing fields.

Since:

Hazelcast 5.0 as BETA

Method Summary

Modifier and Type	Method and Description
boolean[]	readArrayOfBoolean(String fieldName) Reads an array of booleans.
boolean[]	readArrayOfBoolean(String fieldName, boolean[] defaultValue) Reads an array of booleans or returns the default value.
<T> T[]	readArrayOfCompact(String fieldName, Class<T> componentType) Reads an array of compact objects.
<T> T[]	readArrayOfCompact(String fieldName, Class<T> componentType, T[] defaultValue) Reads an array of compact objects or returns the default value.
LocalDate[]	readArrayOfDate(String fieldName) Reads an array of dates consisting of year, month, and day.
LocalDate[]	readArrayOfDate(String fieldName, LocalDate[] defaultValue) Reads an array of dates consisting of year, month, and day or returns the default value.
BigDecimal[]	readArrayOfDecimal(String fieldName) Reads an array of arbitrary precision and scale floating point numbers.
BigDecimal[]	readArrayOfDecimal(String fieldName, BigDecimal[] defaultValue) Reads an array of arbitrary precision and scale floating point numbers or returns the default value.
float[]	readArrayOfFloat32(String fieldName) Reads an array of 32-bit IEEE 754 floating point numbers.
float[]	readArrayOfFloat32(String fieldName, float[] defaultValue) Reads an array of 32-bit IEEE 754 floating point numbers or returns the default value.
double[]	readArrayOfFloat64(String fieldName) Reads an array of 64-bit IEEE 754 floating point numbers.
double[]	readArrayOfFloat64(String fieldName, double[] defaultValue) Reads an array of 64-bit IEEE 754 floating point numbers or returns the default value.
short[]	readArrayOfInt16(String fieldName) Reads an array of 16-bit two's complement signed integers.
short[]	readArrayOfInt16(String fieldName, short[] defaultValue) Reads an array of 16-bit two's complement signed integers or returns the default value.
int[]	readArrayOfInt32(String fieldName) Reads an array of 32-bit two's complement signed integers.
int[]	readArrayOfInt32(String fieldName, int[] defaultValue) Reads an array of 32-bit two's complement signed integers or returns the default value.
long[]	readArrayOfInt64(String fieldName) Reads an array of 64-bit two's complement signed integers.
long[]	readArrayOfInt64(String fieldName, long[] defaultValue) Reads an array of 64-bit two's complement signed integers or returns the default value.
Boolean[]	readArrayOfNullableBoolean(String fieldName) Reads a nullable array of nullable booleans.
Boolean[]	readArrayOfNullableBoolean(String fieldName, Boolean[] defaultValue) Reads a nullable array of nullable booleans or returns the default value.
Float[]	readArrayOfNullableFloat32(String fieldName) Reads a nullable array of nullable 32-bit IEEE 754 floating point numbers.
Float[]	readArrayOfNullableFloat32(String fieldName, Float[] defaultValue) Reads a nullable array of nullable 32-bit IEEE 754 floating point numbers or returns the default value.
Double[]	readArrayOfNullableFloat64(String fieldName) Reads a nullable array of nullable 64-bit IEEE 754 floating point numbers.
Double[]	readArrayOfNullableFloat64(String fieldName, Double[] defaultValue) Reads a nullable array of nullable 64-bit IEEE 754 floating point numbers or returns the default value.
Short[]	readArrayOfNullableInt16(String fieldName) Reads a nullable array of nullable 16-bit two's complement signed integers.
Short[]	readArrayOfNullableInt16(String fieldName, Short[] defaultValue) Reads a nullable array of nullable 16-bit two's complement signed integers or returns the default value.
Integer[]	readArrayOfNullableInt32(String fieldName) Reads a nullable array of nullable 32-bit two's complement signed integers.
Integer[]	readArrayOfNullableInt32(String fieldName, Integer[] defaultValue) Reads a nullable array of nullable 32-bit two's complement signed integers or returns the default value.
Long[]	readArrayOfNullableInt64(String fieldName) Reads a nullable array of nullable 64-bit two's complement signed integers.
Long[]	readArrayOfNullableInt64(String fieldName, Long[] defaultValue) Reads a nullable array of nullable 64-bit two's complement signed integers or returns the default value.
Byte[]	readArrayOfNullableInt8(String fieldName) Reads a nullable array of nullable 8-bit two's complement signed integers.
Byte[]	readArrayOfNullableInt8(String fieldName, Byte[] defaultValue) Reads a nullable array of nullable 8-bit two's complement signed integers or returns the default value.
String[]	readArrayOfString(String fieldName) Reads an array of UTF-8 encoded strings.
String[]	readArrayOfString(String fieldName, String[] defaultValue) Reads an array of UTF-8 encoded strings or returns the default value.
LocalTime[]	readArrayOfTime(String fieldName) Reads an array of times consisting of hour, minute, second, and nanoseconds
LocalTime[]	readArrayOfTime(String fieldName, LocalTime[] defaultValue) Reads an array of times consisting of hour, minute, second, and nanoseconds or returns the default value.
LocalDateTime[]	readArrayOfTimetamp(String fieldName) Reads an array of timestamps consisting of date and time.
LocalDateTime[]	readArrayOfTimetamp(String fieldName, LocalDateTime[] defaultValue) Reads an array of timestamps consisting of date and time or returns the default value.
OffsetDateTime[]	readArrayOfTimetampWithTimezone(String fieldName) Reads an array of timestamps with timezone consisting of date, time and timezone offset.
OffsetDateTime[]	readArrayOfTimetampWithTimezone(String fieldName, OffsetDateTime[] defaultValue) Reads an array of timestamps with timezone consisting of date, time and timezone offset or returns the default value.
byte[]	readArrayOInt(String fieldName) Reads an array of 8-bit two's complement signed integers.
byte[]	readArrayOInt(String fieldName, byte[] defaultValue) Reads an array of 8-bit two's complement signed integers or returns the default value.
boolean	readBoolean(String fieldName) Reads a boolean.
boolean	readBoolean(String fieldName, boolean defaultValue) Reads a boolean or returns the default value.
<T> T	readCompact(String fieldName) Reads a compact object
<T> T	readCompact(String fieldName, T defaultValue) Reads a compact object or returns the default value
LocalDate	readDate(String fieldName) Reads a date consisting of year, month, and day.
LocalDate	readDate(String fieldName, LocalDate defaultValue) Reads a date consisting of year, month, and day or returns the default value.
BigDecimal	readDecimal(String fieldName) Reads an arbitrary precision and scale floating point number.
BigDecimal	readDecimal(String fieldName, BigDecimal defaultValue) Reads an arbitrary precision and scale floating point number or returns the default value.
float	readFloat32(String fieldName) Reads a 32-bit IEEE 754 floating point number.
float	readFloat32(String fieldName, float defaultValue) Reads a 32-bit IEEE 754 floating point number or returns the default value.
double	readFloat64(String fieldName) Reads a 64-bit IEEE 754 floating point number.
double	readFloat64(String fieldName, double defaultValue) Reads a 64-bit IEEE 754 floating point number or returns the default value.
short	readInt16(String fieldName) Reads a 16-bit two's complement signed integer.
short	readInt16(String fieldName, short defaultValue) Reads a 16-bit two's complement signed integer or returns the default value.
int	readInt32(String fieldName) Reads a 32-bit two's complement signed integer.
int	readInt32(String fieldName, int defaultValue) Reads a 32-bit two's complement signed integer or returns the default value.
long	readInt64(String fieldName) Reads a 64-bit two's complement signed integer.
long	readInt64(String fieldName, long defaultValue) Reads a 64-bit two's complement signed integer or returns the default value.
byte	readInt8(String fieldName) Reads an 8-bit two's complement signed integer.
byte	readInt8(String fieldName, byte defaultValue) Reads an 8-bit two's complement signed integer or returns the default value.
Boolean	readNullableBoolean(String fieldName) Reads a nullable boolean.
Boolean	readNullableBoolean(String fieldName, Boolean defaultValue) Reads a nullable boolean or returns the default value.
Float	readNullableFloat32(String fieldName) Reads a nullable 32-bit IEEE 754 floating point number.
Float	readNullableFloat32(String fieldName, Float defaultValue) Reads a nullable 32-bit IEEE 754 floating point number or returns the default value.
Double	readNullableFloat64(String fieldName) Reads a nullable 64-bit IEEE 754 floating point number.
Double	readNullableFloat64(String fieldName, Double defaultValue) Reads a nullable 64-bit IEEE 754 floating point number or returns the default value.
Short	readNullableInt16(String fieldName) Reads a nullable 16-bit two's complement signed integer.
Short	readNullableInt16(String fieldName, Short defaultValue) Reads a nullable 16-bit two's complement signed integer or returns the default value.
Integer	readNullableInt32(String fieldName) Reads a nullable 32-bit two's complement signed integer.
Integer	readNullableInt32(String fieldName, Integer defaultValue) Reads a nullable 32-bit two's complement signed integer or returns the default value.
Long	readNullableInt64(String fieldName) Reads a nullable 64-bit two's complement signed integer.
Long	readNullableInt64(String fieldName, Long defaultValue) Reads a nullable 64-bit two's complement signed integer or returns the default value.
Byte	readNullableInt8(String fieldName) Reads a nullable 8-bit two's complement signed integer.
Byte	readNullableInt8(String fieldName, Byte defaultValue) Reads a nullable 8-bit two's complement signed integer or returns the default value.
String	readString(String fieldName) Reads an UTF-8 encoded string.
String	readString(String fieldName, String defaultValue) Reads an UTF-8 encoded string or returns the default value.
LocalTime	readTime(String fieldName) Reads a time consisting of hour, minute, second, and nano seconds.
LocalTime	readTime(String fieldName, LocalTime defaultValue) Reads a time consisting of hour, minute, second, and nano seconds or returns the default value.
LocalDateTime	readTimestamp(String fieldName) Reads a timestamp consisting of date and time.
LocalDateTime	readTimestamp(String fieldName, LocalDateTime defaultValue) Reads a timestamp consisting of date and time or returns the default value.
OffsetDateTime	readTimestampWithTimezone(String fieldName) Reads a timestamp with timezone consisting of date, time and timezone offset.
OffsetDateTime	readTimestampWithTimezone(String fieldName, OffsetDateTime defaultValue) Reads a timestamp with timezone consisting of date, time and timezone offset or returns the default value.

Method Detail

readBoolean

boolean readBoolean(@Nonnull
                    String fieldName)

Reads a boolean.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readBoolean

boolean readBoolean(@Nonnull
                    String fieldName,
                    boolean defaultValue)

Reads a boolean or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readInt8

byte readInt8(@Nonnull
              String fieldName)

Reads an 8-bit two's complement signed integer.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readInt8

byte readInt8(@Nonnull
              String fieldName,
              byte defaultValue)

Reads an 8-bit two's complement signed integer or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readInt16

short readInt16(@Nonnull
                String fieldName)

Reads a 16-bit two's complement signed integer.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readInt16

short readInt16(@Nonnull
                String fieldName,
                short defaultValue)

Reads a 16-bit two's complement signed integer or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readInt32

int readInt32(@Nonnull
              String fieldName)

Reads a 32-bit two's complement signed integer.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readInt32

int readInt32(@Nonnull
              String fieldName,
              int defaultValue)

Reads a 32-bit two's complement signed integer or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readInt64

long readInt64(@Nonnull
               String fieldName)

Reads a 64-bit two's complement signed integer.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readInt64

long readInt64(@Nonnull
               String fieldName,
               long defaultValue)

Reads a 64-bit two's complement signed integer or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readFloat32

float readFloat32(@Nonnull
                  String fieldName)

Reads a 32-bit IEEE 754 floating point number.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readFloat32

float readFloat32(@Nonnull
                  String fieldName,
                  float defaultValue)

Reads a 32-bit IEEE 754 floating point number or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readFloat64

double readFloat64(@Nonnull
                   String fieldName)

Reads a 64-bit IEEE 754 floating point number.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readFloat64

double readFloat64(@Nonnull
                   String fieldName,
                   double defaultValue)

Reads a 64-bit IEEE 754 floating point number or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readString

@Nullable
String readString(@Nonnull
                            String fieldName)

Reads an UTF-8 encoded string.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readString

@Nullable
String readString(@Nonnull
                            String fieldName,
                            @Nullable
                            String defaultValue)

Reads an UTF-8 encoded string or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readDecimal

@Nullable
BigDecimal readDecimal(@Nonnull
                                 String fieldName)

Reads an arbitrary precision and scale floating point number.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readDecimal

@Nullable
BigDecimal readDecimal(@Nonnull
                                 String fieldName,
                                 @Nullable
                                 BigDecimal defaultValue)

Reads an arbitrary precision and scale floating point number or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readTime

@Nullable
LocalTime readTime(@Nonnull
                             String fieldName)

Reads a time consisting of hour, minute, second, and nano seconds.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readTime

@Nullable
LocalTime readTime(@Nonnull
                             String fieldName,
                             @Nullable
                             LocalTime defaultValue)

Reads a time consisting of hour, minute, second, and nano seconds or returns the default value.

This method may only return null, if the defaultValue is null.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readDate

@Nullable
LocalDate readDate(@Nonnull
                             String fieldName)

Reads a date consisting of year, month, and day.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readDate

@Nullable
LocalDate readDate(@Nonnull
                             String fieldName,
                             @Nullable
                             LocalDate defaultValue)

Reads a date consisting of year, month, and day or returns the default value.

This method may only return null, if the defaultValue is null.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readTimestamp

@Nullable
LocalDateTime readTimestamp(@Nonnull
                                      String fieldName)

Reads a timestamp consisting of date and time.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readTimestamp

@Nullable
LocalDateTime readTimestamp(@Nonnull
                                      String fieldName,
                                      @Nullable
                                      LocalDateTime defaultValue)

Reads a timestamp consisting of date and time or returns the default value.

This method may only return null, if the defaultValue is null.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readTimestampWithTimezone

@Nullable
OffsetDateTime readTimestampWithTimezone(@Nonnull
                                                   String fieldName)

Reads a timestamp with timezone consisting of date, time and timezone offset.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readTimestampWithTimezone

@Nullable
OffsetDateTime readTimestampWithTimezone(@Nonnull
                                                   String fieldName,
                                                   @Nullable
                                                   OffsetDateTime defaultValue)

Reads a timestamp with timezone consisting of date, time and timezone offset or returns the default value.

This method may only return null, if the defaultValue is null.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readCompact

@Nullable
<T> T readCompact(@Nonnull
                            String fieldName)

Reads a compact object

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

HazelcastException - if the object cannot be created.

readCompact

@Nullable
<T> T readCompact(@Nonnull
                            String fieldName,
                            @Nullable
                            T defaultValue)

Reads a compact object or returns the default value

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfBoolean

@Nullable
boolean[] readArrayOfBoolean(@Nonnull
                                       String fieldName)

Reads an array of booleans.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfBoolean

@Nullable
boolean[] readArrayOfBoolean(@Nonnull
                                       String fieldName,
                                       @Nullable
                                       boolean[] defaultValue)

Reads an array of booleans or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOInt

@Nullable
byte[] readArrayOInt(@Nonnull
                               String fieldName)

Reads an array of 8-bit two's complement signed integers.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOInt

@Nullable
byte[] readArrayOInt(@Nonnull
                               String fieldName,
                               @Nullable
                               byte[] defaultValue)

Reads an array of 8-bit two's complement signed integers or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfInt16

@Nullable
short[] readArrayOfInt16(@Nonnull
                                   String fieldName)

Reads an array of 16-bit two's complement signed integers.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfInt16

@Nullable
short[] readArrayOfInt16(@Nonnull
                                   String fieldName,
                                   @Nullable
                                   short[] defaultValue)

Reads an array of 16-bit two's complement signed integers or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfInt32

@Nullable
int[] readArrayOfInt32(@Nonnull
                                 String fieldName)

Reads an array of 32-bit two's complement signed integers.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfInt32

@Nullable
int[] readArrayOfInt32(@Nonnull
                                 String fieldName,
                                 @Nullable
                                 int[] defaultValue)

Reads an array of 32-bit two's complement signed integers or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfInt64

@Nullable
long[] readArrayOfInt64(@Nonnull
                                  String fieldName)

Reads an array of 64-bit two's complement signed integers.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfInt64

@Nullable
long[] readArrayOfInt64(@Nonnull
                                  String fieldName,
                                  @Nullable
                                  long[] defaultValue)

Reads an array of 64-bit two's complement signed integers or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfFloat32

@Nullable
float[] readArrayOfFloat32(@Nonnull
                                     String fieldName)

Reads an array of 32-bit IEEE 754 floating point numbers.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfFloat32

@Nullable
float[] readArrayOfFloat32(@Nonnull
                                     String fieldName,
                                     @Nullable
                                     float[] defaultValue)

Reads an array of 32-bit IEEE 754 floating point numbers or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfFloat64

@Nullable
double[] readArrayOfFloat64(@Nonnull
                                      String fieldName)

Reads an array of 64-bit IEEE 754 floating point numbers.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfFloat64

@Nullable
double[] readArrayOfFloat64(@Nonnull
                                      String fieldName,
                                      @Nullable
                                      double[] defaultValue)

Reads an array of 64-bit IEEE 754 floating point numbers or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfString

@Nullable
String[] readArrayOfString(@Nonnull
                                     String fieldName)

Reads an array of UTF-8 encoded strings.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfString

@Nullable
String[] readArrayOfString(@Nonnull
                                     String fieldName,
                                     @Nullable
                                     String[] defaultValue)

Reads an array of UTF-8 encoded strings or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfDecimal

@Nullable
BigDecimal[] readArrayOfDecimal(@Nonnull
                                          String fieldName)

Reads an array of arbitrary precision and scale floating point numbers.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfDecimal

@Nullable
BigDecimal[] readArrayOfDecimal(@Nonnull
                                          String fieldName,
                                          @Nullable
                                          BigDecimal[] defaultValue)

Reads an array of arbitrary precision and scale floating point numbers or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfTime

@Nullable
LocalTime[] readArrayOfTime(@Nonnull
                                      String fieldName)

Reads an array of times consisting of hour, minute, second, and nanoseconds

Parameters:

fieldName - name of the field.

Returns:

the value of the field. The items in the array cannot be null.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfTime

@Nullable
LocalTime[] readArrayOfTime(@Nonnull
                                      String fieldName,
                                      @Nullable
                                      LocalTime[] defaultValue)

Reads an array of times consisting of hour, minute, second, and nanoseconds or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfDate

@Nullable
LocalDate[] readArrayOfDate(@Nonnull
                                      String fieldName)

Reads an array of dates consisting of year, month, and day.

Parameters:

fieldName - name of the field.

Returns:

the value of the field. The items in the array cannot be null.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfDate

@Nullable
LocalDate[] readArrayOfDate(@Nonnull
                                      String fieldName,
                                      @Nullable
                                      LocalDate[] defaultValue)

Reads an array of dates consisting of year, month, and day or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfTimetamp

@Nullable
LocalDateTime[] readArrayOfTimetamp(@Nonnull
                                              String fieldName)

Reads an array of timestamps consisting of date and time.

Parameters:

fieldName - name of the field.

Returns:

the value of the field. The items in the array cannot be null.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfTimetamp

@Nullable
LocalDateTime[] readArrayOfTimetamp(@Nonnull
                                              String fieldName,
                                              @Nullable
                                              LocalDateTime[] defaultValue)

Reads an array of timestamps consisting of date and time or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfTimetampWithTimezone

@Nullable
OffsetDateTime[] readArrayOfTimetampWithTimezone(@Nonnull
                                                           String fieldName)

Reads an array of timestamps with timezone consisting of date, time and timezone offset.

Parameters:

fieldName - name of the field.

Returns:

the value of the field. The items in the array cannot be null.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfTimetampWithTimezone

@Nullable
OffsetDateTime[] readArrayOfTimetampWithTimezone(@Nonnull
                                                           String fieldName,
                                                           @Nullable
                                                           OffsetDateTime[] defaultValue)

Reads an array of timestamps with timezone consisting of date, time and timezone offset or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfCompact

@Nullable
<T> T[] readArrayOfCompact(@Nonnull
                                     String fieldName,
                                     @Nullable
                                     Class<T> componentType)

Reads an array of compact objects.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfCompact

@Nullable
<T> T[] readArrayOfCompact(@Nonnull
                                     String fieldName,
                                     @Nullable
                                     Class<T> componentType,
                                     @Nullable
                                     T[] defaultValue)

Reads an array of compact objects or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readNullableBoolean

@Nullable
Boolean readNullableBoolean(@Nonnull
                                      String fieldName)

Reads a nullable boolean.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readNullableBoolean

@Nullable
Boolean readNullableBoolean(@Nonnull
                                      String fieldName,
                                      @Nullable
                                      Boolean defaultValue)

Reads a nullable boolean or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readNullableInt8

@Nullable
Byte readNullableInt8(@Nonnull
                                String fieldName)

Reads a nullable 8-bit two's complement signed integer.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readNullableInt8

@Nullable
Byte readNullableInt8(@Nonnull
                                String fieldName,
                                @Nullable
                                Byte defaultValue)

Reads a nullable 8-bit two's complement signed integer or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readNullableInt16

Short readNullableInt16(@Nonnull
                        String fieldName)

Reads a nullable 16-bit two's complement signed integer.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readNullableInt16

Short readNullableInt16(@Nonnull
                        String fieldName,
                        @Nullable
                        Short defaultValue)

Reads a nullable 16-bit two's complement signed integer or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readNullableInt32

@Nullable
Integer readNullableInt32(@Nonnull
                                    String fieldName)

Reads a nullable 32-bit two's complement signed integer.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readNullableInt32

@Nullable
Integer readNullableInt32(@Nonnull
                                    String fieldName,
                                    @Nullable
                                    Integer defaultValue)

Reads a nullable 32-bit two's complement signed integer or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readNullableInt64

@Nullable
Long readNullableInt64(@Nonnull
                                 String fieldName)

Reads a nullable 64-bit two's complement signed integer.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readNullableInt64

@Nullable
Long readNullableInt64(@Nonnull
                                 String fieldName,
                                 @Nullable
                                 Long defaultValue)

Reads a nullable 64-bit two's complement signed integer or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readNullableFloat32

@Nullable
Float readNullableFloat32(@Nonnull
                                    String fieldName)

Reads a nullable 32-bit IEEE 754 floating point number.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readNullableFloat32

@Nullable
Float readNullableFloat32(@Nonnull
                                    String fieldName,
                                    @Nullable
                                    Float defaultValue)

Reads a nullable 32-bit IEEE 754 floating point number or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readNullableFloat64

@Nullable
Double readNullableFloat64(@Nonnull
                                     String fieldName)

Reads a nullable 64-bit IEEE 754 floating point number.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readNullableFloat64

@Nullable
Double readNullableFloat64(@Nonnull
                                     String fieldName,
                                     @Nullable
                                     Double defaultValue)

Reads a nullable 64-bit IEEE 754 floating point number or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfNullableBoolean

@Nullable
Boolean[] readArrayOfNullableBoolean(@Nonnull
                                               String fieldName)

Reads a nullable array of nullable booleans.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfNullableBoolean

@Nullable
Boolean[] readArrayOfNullableBoolean(@Nonnull
                                               String fieldName,
                                               @Nullable
                                               Boolean[] defaultValue)

Reads a nullable array of nullable booleans or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfNullableInt8

@Nullable
Byte[] readArrayOfNullableInt8(@Nonnull
                                         String fieldName)

Reads a nullable array of nullable 8-bit two's complement signed integers.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfNullableInt8

@Nullable
Byte[] readArrayOfNullableInt8(@Nonnull
                                         String fieldName,
                                         @Nullable
                                         Byte[] defaultValue)

Reads a nullable array of nullable 8-bit two's complement signed integers or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfNullableInt16

@Nullable
Short[] readArrayOfNullableInt16(@Nonnull
                                           String fieldName)

Reads a nullable array of nullable 16-bit two's complement signed integers.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfNullableInt16

@Nullable
Short[] readArrayOfNullableInt16(@Nonnull
                                           String fieldName,
                                           @Nullable
                                           Short[] defaultValue)

Reads a nullable array of nullable 16-bit two's complement signed integers or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfNullableInt32

@Nullable
Integer[] readArrayOfNullableInt32(@Nonnull
                                             String fieldName)

Reads a nullable array of nullable 32-bit two's complement signed integers.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfNullableInt32

@Nullable
Integer[] readArrayOfNullableInt32(@Nonnull
                                             String fieldName,
                                             @Nullable
                                             Integer[] defaultValue)

Reads a nullable array of nullable 32-bit two's complement signed integers or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfNullableInt64

@Nullable
Long[] readArrayOfNullableInt64(@Nonnull
                                          String fieldName)

Reads a nullable array of nullable 64-bit two's complement signed integers.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfNullableInt64

@Nullable
Long[] readArrayOfNullableInt64(@Nonnull
                                          String fieldName,
                                          @Nullable
                                          Long[] defaultValue)

Reads a nullable array of nullable 64-bit two's complement signed integers or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfNullableFloat32

@Nullable
Float[] readArrayOfNullableFloat32(@Nonnull
                                             String fieldName)

Reads a nullable array of nullable 32-bit IEEE 754 floating point numbers.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfNullableFloat32

@Nullable
Float[] readArrayOfNullableFloat32(@Nonnull
                                             String fieldName,
                                             @Nullable
                                             Float[] defaultValue)

Reads a nullable array of nullable 32-bit IEEE 754 floating point numbers or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.

readArrayOfNullableFloat64

@Nullable
Double[] readArrayOfNullableFloat64(@Nonnull
                                              String fieldName)

Reads a nullable array of nullable 64-bit IEEE 754 floating point numbers.

Parameters:

fieldName - name of the field.

Returns:

the value of the field.

Throws:

HazelcastSerializationException - if the field does not exist in the schema or the type of the field does not match with the one defined in the schema.

readArrayOfNullableFloat64

@Nullable
Double[] readArrayOfNullableFloat64(@Nonnull
                                              String fieldName,
                                              @Nullable
                                              Double[] defaultValue)

Reads a nullable array of nullable 64-bit IEEE 754 floating point numbers or returns the default value.

Parameters:

fieldName - name of the field.

defaultValue - default value to return if the field with the given name does not exist in the schema or the type of the field does not match with the one defined in the schema.

Returns:

the value or the default value of the field.