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	readBoolean(String fieldName) Reads a boolean.
boolean	readBoolean(String fieldName, boolean defaultValue) Reads a boolean or returns the default value.
boolean[]	readBooleanArray(String fieldName) Reads an array of booleans.
boolean[]	readBooleanArray(String fieldName, boolean[] defaultValue) Reads an array of booleans or returns the default value.
byte	readByte(String fieldName) Reads an 8-bit two's complement signed integer.
byte	readByte(String fieldName, byte defaultValue) Reads an 8-bit two's complement signed integer or returns the default value.
byte[]	readByteArray(String fieldName) Reads an array of 8-bit two's complement signed integers.
byte[]	readByteArray(String fieldName, byte[] defaultValue) Reads an array of 8-bit two's complement signed integers or returns the default value.
char	readChar(String fieldName) Reads a 16-bit unsigned integer.
char	readChar(String fieldName, char defaultValue) Reads a 16-bit unsigned integer or returns the default value.
char[]	readCharArray(String fieldName) Reads an array of 16-bit unsigned integers.
char[]	readCharArray(String fieldName, char[] defaultValue) Reads an array of 16-bit unsigned integers 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.
LocalDate[]	readDateArray(String fieldName) Reads an array of dates consisting of year, month, and day.
LocalDate[]	readDateArray(String fieldName, LocalDate[] defaultValue) Reads an array of dates 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.
BigDecimal[]	readDecimalArray(String fieldName) Reads an array of arbitrary precision and scale floating point numbers.
BigDecimal[]	readDecimalArray(String fieldName, BigDecimal[] defaultValue) Reads an array of arbitrary precision and scale floating point numbers or returns the default value.
double	readDouble(String fieldName) Reads a 64-bit IEEE 754 floating point number.
double	readDouble(String fieldName, double defaultValue) Reads a 64-bit IEEE 754 floating point number or returns the default value.
double[]	readDoubleArray(String fieldName) Reads an array of 64-bit IEEE 754 floating point numbers.
double[]	readDoubleArray(String fieldName, double[] defaultValue) Reads an array of 64-bit IEEE 754 floating point numbers or returns the default value.
float	readFloat(String fieldName) Reads a 32-bit IEEE 754 floating point number.
float	readFloat(String fieldName, float defaultValue) Reads a 32-bit IEEE 754 floating point number or returns the default value.
float[]	readFloatArray(String fieldName) Reads an array of 32-bit IEEE 754 floating point numbers.
float[]	readFloatArray(String fieldName, float[] defaultValue) Reads an array of 32-bit IEEE 754 floating point numbers or returns the default value.
int	readInt(String fieldName) Reads a 32-bit two's complement signed integer.
int	readInt(String fieldName, int defaultValue) Reads a 32-bit two's complement signed integer or returns the default value.
int[]	readIntArray(String fieldName) Reads an array of 32-bit two's complement signed integers.
int[]	readIntArray(String fieldName, int[] defaultValue) Reads an array of 32-bit two's complement signed integers or returns the default value.
long	readLong(String fieldName) Reads a 64-bit two's complement signed integer.
long	readLong(String fieldName, long defaultValue) Reads a 64-bit two's complement signed integer or returns the default value.
long[]	readLongArray(String fieldName) Reads an array of 64-bit two's complement signed integers.
long[]	readLongArray(String fieldName, long[] defaultValue) Reads an array of 64-bit two's complement signed integers or returns the default value.
<T> T	readObject(String fieldName) Reads an arbitrary object.
<T> T	readObject(String fieldName, T defaultValue) Reads an arbitrary object or returns the default value.
<T> T[]	readObjectArray(String fieldName, Class<T> componentType) Reads an array of arbitrary objects.
<T> T[]	readObjectArray(String fieldName, Class<T> componentType, T[] defaultValue) Reads an array of arbitrary objects or returns the default value.
short	readShort(String fieldName) Reads a 16-bit two's complement signed integer.
short	readShort(String fieldName, short defaultValue) Reads a 16-bit two's complement signed integer or returns the default value.
short[]	readShortArray(String fieldName) Reads an array of 16-bit two's complement signed integers.
short[]	readShortArray(String fieldName, short[] defaultValue) Reads an array of 16-bit two's complement signed integers 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.
String[]	readStringArray(String fieldName) Reads an array of UTF-8 encoded strings.
String[]	readStringArray(String fieldName, String[] defaultValue) Reads an array of UTF-8 encoded strings 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.
LocalTime[]	readTimeArray(String fieldName) Reads an array of times consisting of hour, minute, second, and nano seconds.
LocalTime[]	readTimeArray(String fieldName, LocalTime[] defaultValue) Reads an array of times 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.
LocalDateTime[]	readTimestampArray(String fieldName) Reads an array of timestamps consisting of date and time.
LocalDateTime[]	readTimestampArray(String fieldName, LocalDateTime[] defaultValue) Reads an array of timestamps 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.
OffsetDateTime[]	readTimestampWithTimezoneArray(String fieldName) Reads an array of timestamps with timezone consisting of date, time and timezone offset.
OffsetDateTime[]	readTimestampWithTimezoneArray(String fieldName, OffsetDateTime[] defaultValue) Reads an array of timestamps with timezone consisting of date, time and timezone offset or returns the default value.

Method Detail

readByte

byte readByte(@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.

readByte

byte readByte(@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.

readShort

short readShort(@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.

readShort

short readShort(@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.

readInt

int readInt(@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.

readInt

int readInt(@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.

readLong

long readLong(@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.

readLong

long readLong(@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.

readFloat

float readFloat(@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.

readFloat

float readFloat(@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.

readDouble

double readDouble(@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.

readDouble

double readDouble(@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.

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.

readChar

char readChar(@Nonnull
              String fieldName)

Reads a 16-bit unsigned 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.

readChar

char readChar(@Nonnull
              String fieldName,
              char defaultValue)

Reads a 16-bit unsigned 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.

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

@Nonnull
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

@Nonnull
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

@Nonnull
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

@Nonnull
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.

readObject

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

Reads an arbitrary 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.

readObject

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

Reads an arbitrary 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.

Throws:

HazelcastException - if the object cannot be created.

readByteArray

@Nullable
byte[] readByteArray(@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.

readByteArray

@Nullable
byte[] readByteArray(@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.

readBooleanArray

@Nullable
boolean[] readBooleanArray(@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.

readBooleanArray

@Nullable
boolean[] readBooleanArray(@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.

readCharArray

@Nullable
char[] readCharArray(@Nonnull
                               String fieldName)

Reads an array of 16-bit unsigned 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.

readCharArray

@Nullable
char[] readCharArray(@Nonnull
                               String fieldName,
                               @Nullable
                               char[] defaultValue)

Reads an array of 16-bit unsigned 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.

readIntArray

@Nullable
int[] readIntArray(@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.

readIntArray

@Nullable
int[] readIntArray(@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.

readLongArray

@Nullable
long[] readLongArray(@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.

readLongArray

@Nullable
long[] readLongArray(@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.

readDoubleArray

@Nullable
double[] readDoubleArray(@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.

readDoubleArray

@Nullable
double[] readDoubleArray(@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.

readFloatArray

@Nullable
float[] readFloatArray(@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.

readFloatArray

@Nullable
float[] readFloatArray(@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.

readShortArray

@Nullable
short[] readShortArray(@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.

readShortArray

@Nullable
short[] readShortArray(@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.

readStringArray

@Nullable
String[] readStringArray(@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.

readStringArray

@Nullable
String[] readStringArray(@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.

readDecimalArray

@Nullable
BigDecimal[] readDecimalArray(@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.

readDecimalArray

@Nullable
BigDecimal[] readDecimalArray(@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.

readTimeArray

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

Reads an array of times consisting of hour, minute, second, and nano seconds.

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.

readTimeArray

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

Reads an array of times consisting of hour, minute, second, and nano seconds 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. The items in the array cannot be null except for the items in the provided defaultValue.

readDateArray

@Nullable
LocalDate[] readDateArray(@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.

readDateArray

@Nullable
LocalDate[] readDateArray(@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. The items in the array cannot be null except for the items in the provided defaultValue.

readTimestampArray

@Nullable
LocalDateTime[] readTimestampArray(@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.

readTimestampArray

@Nullable
LocalDateTime[] readTimestampArray(@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. The items in the array cannot be null except for the items in the provided defaultValue.

readTimestampWithTimezoneArray

@Nullable
OffsetDateTime[] readTimestampWithTimezoneArray(@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.

readTimestampWithTimezoneArray

@Nullable
OffsetDateTime[] readTimestampWithTimezoneArray(@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. The items in the array cannot be null except for the items in the provided defaultValue.

readObjectArray

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

Reads an array of arbitrary 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.

readObjectArray

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

Reads an array of arbitrary 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.