CompactReader | hazelcast-client

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

Read operations might throw HazelcastSerializationError when a field with the given name is not found or there is a type mismatch. On such occasions, one might handle this case via the getFieldKind method. Handling this situation might be especially useful if the class might evolve in future, either by adding or removing fields.

This API is currently in Beta and can change at any time.

Hierarchy

CompactReader

Methods

getFieldKind

getFieldKind(fieldName: string): FieldKind

- Defined in src/serialization/compact/CompactReader.ts:38
Returns field type for the given field name. Returns FieldKind.NOT_AVAILABLE if such field does not exist.

Parameters
- fieldName: string
  
  the name of the field
Returns FieldKind

readArrayOfBoolean

readArrayOfBoolean(fieldName: string): boolean[]

- Defined in src/serialization/compact/CompactReader.ts:188
Reads an array of booleans.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns boolean[]
the value of the field.

readArrayOfCompact

readArrayOfCompact<T>(fieldName: string): T[]

- Defined in src/serialization/compact/CompactReader.ts:319
Reads an array of compact objects.

throws
HazelcastSerializationError 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.

Type parameters
- T
Parameters
- fieldName: string
  
  name of the field.
Returns T[]
the value of the field.

readArrayOfDate

readArrayOfDate(fieldName: string): LocalDate[]

- Defined in src/serialization/compact/CompactReader.ts:289
Reads an array of LocalDate objects consisting of year, month, and day.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns LocalDate[]
the value of the field.

readArrayOfDecimal

readArrayOfDecimal(fieldName: string): BigDecimal[]

- Defined in src/serialization/compact/CompactReader.ts:268
Reads an array of BigDecimal objects.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns BigDecimal[]
the value of the field.

readArrayOfFloat32

readArrayOfFloat32(fieldName: string): number[]

- Defined in src/serialization/compact/CompactReader.ts:238
Reads an array of 32-bit IEEE 754 floating point numbers.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number[]
the value of the field.

readArrayOfFloat64

readArrayOfFloat64(fieldName: string): number[]

- Defined in src/serialization/compact/CompactReader.ts:248
Reads an array of 64-bit IEEE 754 floating point numbers.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number[]
the value of the field.

readArrayOfInt16

readArrayOfInt16(fieldName: string): number[]

- Defined in src/serialization/compact/CompactReader.ts:208
Reads an array of 16-bit two's complement signed integers.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number[]
the value of the field.

readArrayOfInt32

readArrayOfInt32(fieldName: string): number[]

- Defined in src/serialization/compact/CompactReader.ts:218
Reads an array of 32-bit two's complement signed integers.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number[]
the value of the field.

readArrayOfInt64

readArrayOfInt64(fieldName: string): Long[]

- Defined in src/serialization/compact/CompactReader.ts:228
Reads an array of 64-bit two's complement signed integers.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns Long[]
the value of the field.

readArrayOfInt8

readArrayOfInt8(fieldName: string): Buffer

- Defined in src/serialization/compact/CompactReader.ts:198
Reads an array of 8-bit two's complement signed integers.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns Buffer
the value of the field.

readArrayOfNullableBoolean

readArrayOfNullableBoolean(fieldName: string): boolean[]

- Defined in src/serialization/compact/CompactReader.ts:399
Reads a nullable array of nullable booleans.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns boolean[]
the value of the field.

readArrayOfNullableFloat32

readArrayOfNullableFloat32(fieldName: string): number[]

- Defined in src/serialization/compact/CompactReader.ts:449
Reads a nullable array of nullable 32-bit IEEE 754 floating point numbers.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number[]
the value of the field.

readArrayOfNullableFloat64

readArrayOfNullableFloat64(fieldName: string): number[]

- Defined in src/serialization/compact/CompactReader.ts:459
Reads a nullable array of nullable 64-bit IEEE 754 floating point numbers.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number[]
the value of the field.

readArrayOfNullableInt16

readArrayOfNullableInt16(fieldName: string): number[]

- Defined in src/serialization/compact/CompactReader.ts:419
Reads a nullable array of nullable 16-bit two's complement signed integers.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number[]
the value of the field.

readArrayOfNullableInt32

readArrayOfNullableInt32(fieldName: string): number[]

- Defined in src/serialization/compact/CompactReader.ts:429
Reads a nullable array of nullable 32-bit two's complement signed integers.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number[]
the value of the field.

readArrayOfNullableInt64

readArrayOfNullableInt64(fieldName: string): Long[]

- Defined in src/serialization/compact/CompactReader.ts:439
Reads a nullable array of nullable 64-bit two's complement signed integers.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns Long[]
the value of the field.

readArrayOfNullableInt8

readArrayOfNullableInt8(fieldName: string): number[]

- Defined in src/serialization/compact/CompactReader.ts:409
Reads a nullable array of nullable 8-bit two's complement signed integers.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number[]
the value of the field.

readArrayOfString

readArrayOfString(fieldName: string): string[]

- Defined in src/serialization/compact/CompactReader.ts:258
Reads an array of UTF-8 encoded strings.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns string[]
the value of the field.

readArrayOfTime

readArrayOfTime(fieldName: string): LocalTime[]

- Defined in src/serialization/compact/CompactReader.ts:279
Reads an array of LocalTime objects consisting of hour, minute, second, and nanoseconds.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns LocalTime[]
the value of the field.

readArrayOfTimestamp

readArrayOfTimestamp(fieldName: string): LocalDateTime[]

- Defined in src/serialization/compact/CompactReader.ts:299
Reads an array of LocalDateTime objects consisting of date and time.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns LocalDateTime[]
the value of the field.

readArrayOfTimestampWithTimezone

readArrayOfTimestampWithTimezone(fieldName: string): OffsetDateTime[]

- Defined in src/serialization/compact/CompactReader.ts:309
Reads an array of OffsetDateTime objects consisting of date, time and timezone offset.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns OffsetDateTime[]
the value of the field.

readBoolean

readBoolean(fieldName: string): boolean

- Defined in src/serialization/compact/CompactReader.ts:48
Reads a boolean.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns boolean
the value of the field.

readCompact

readCompact<T>(fieldName: string): T

- Defined in src/serialization/compact/CompactReader.ts:178
Reads a compact object.

throws
HazelcastSerializationError 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.

Type parameters
- T
Parameters
- fieldName: string
  
  name of the field.
Returns T
the value of the field.

readDate

readDate(fieldName: string): LocalDate

- Defined in src/serialization/compact/CompactReader.ts:148
Reads a LocalDate consisting of year, month, and day.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns LocalDate
the value of the field.

readDecimal

readDecimal(fieldName: string): BigDecimal

- Defined in src/serialization/compact/CompactReader.ts:128
Reads an arbitrary precision and scale floating point number.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns BigDecimal
the value of the field.

readFloat32

readFloat32(fieldName: string): number

- Defined in src/serialization/compact/CompactReader.ts:98
Reads a 32-bit IEEE 754 floating point number.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number
the value of the field.

readFloat64

readFloat64(fieldName: string): number

- Defined in src/serialization/compact/CompactReader.ts:108
Reads a 64-bit IEEE 754 floating point number.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number
the value of the field.

readInt16

readInt16(fieldName: string): number

- Defined in src/serialization/compact/CompactReader.ts:68
Reads a 16-bit two's complement signed integer.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number
the value of the field.

readInt32

readInt32(fieldName: string): number

- Defined in src/serialization/compact/CompactReader.ts:78
Reads a 32-bit two's complement signed integer.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number
the value of the field.

readInt64

readInt64(fieldName: string): Long

- Defined in src/serialization/compact/CompactReader.ts:88
Reads a 64-bit two's complement signed integer.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns Long
the value of the field.

readInt8

readInt8(fieldName: string): number

- Defined in src/serialization/compact/CompactReader.ts:58
Reads an 8-bit two's complement signed integer.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number
the value of the field.

readNullableBoolean

readNullableBoolean(fieldName: string): boolean

- Defined in src/serialization/compact/CompactReader.ts:329
Reads a nullable boolean.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns boolean
the value of the field.

readNullableFloat32

readNullableFloat32(fieldName: string): number

- Defined in src/serialization/compact/CompactReader.ts:379
Reads a nullable 32-bit IEEE 754 floating point number.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number
the value of the field.

readNullableFloat64

readNullableFloat64(fieldName: string): number

- Defined in src/serialization/compact/CompactReader.ts:389
Reads a nullable 64-bit IEEE 754 floating point number.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number
the value of the field.

readNullableInt16

readNullableInt16(fieldName: string): number

- Defined in src/serialization/compact/CompactReader.ts:349
Reads a nullable 16-bit two's complement signed integer.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number
the value of the field.

readNullableInt32

readNullableInt32(fieldName: string): number

- Defined in src/serialization/compact/CompactReader.ts:359
Reads a nullable 32-bit two's complement signed integer.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number
the value of the field.

readNullableInt64

readNullableInt64(fieldName: string): Long

- Defined in src/serialization/compact/CompactReader.ts:369
Reads a nullable 64-bit two's complement signed integer.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns Long
the value of the field.

readNullableInt8

readNullableInt8(fieldName: string): number

- Defined in src/serialization/compact/CompactReader.ts:339
Reads a nullable 8-bit two's complement signed integer.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns number
the value of the field.

readString

readString(fieldName: string): string

- Defined in src/serialization/compact/CompactReader.ts:118
Reads a UTF-8 encoded string.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns string
the value of the field.

readTime

readTime(fieldName: string): LocalTime

- Defined in src/serialization/compact/CompactReader.ts:138
Reads a LocalTime consisting of hour, minute, second, and nano seconds.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns LocalTime
the value of the field.

readTimestamp

readTimestamp(fieldName: string): LocalDateTime

- Defined in src/serialization/compact/CompactReader.ts:158
Reads a LocalDateTime consisting of date and time.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns LocalDateTime
the value of the field.

readTimestampWithTimezone

readTimestampWithTimezone(fieldName: string): OffsetDateTime

- Defined in src/serialization/compact/CompactReader.ts:168
Reads a OffsetDateTime consisting of date, time and timezone offset.

throws
HazelcastSerializationError 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.

Parameters
- fieldName: string
  
  name of the field.
Returns OffsetDateTime
the value of the field.

Hierarchy

Index

Methods

Methods

getFieldKind

Parameters

fieldName: string

Returns FieldKind

readArrayOfBoolean

Parameters

fieldName: string

Returns boolean[]

readArrayOfCompact

Type parameters

T

Parameters

fieldName: string

Returns T[]

readArrayOfDate

Parameters

fieldName: string

Returns LocalDate[]

readArrayOfDecimal

Parameters

fieldName: string

Returns BigDecimal[]

readArrayOfFloat32

Parameters

fieldName: string

Returns number[]

readArrayOfFloat64

Parameters

fieldName: string

Returns number[]

readArrayOfInt16

Parameters

fieldName: string

Returns number[]

readArrayOfInt32

Parameters

fieldName: string

Returns number[]

readArrayOfInt64

Parameters

fieldName: string

Returns Long[]

readArrayOfInt8

Parameters

fieldName: string

Returns Buffer

readArrayOfNullableBoolean

Parameters

fieldName: string

Returns boolean[]

readArrayOfNullableFloat32

Parameters

fieldName: string

Returns number[]

readArrayOfNullableFloat64

Parameters

fieldName: string

Returns number[]

readArrayOfNullableInt16

Parameters

fieldName: string

Returns number[]

readArrayOfNullableInt32

Parameters

fieldName: string

Returns number[]

readArrayOfNullableInt64

Parameters

fieldName: string

Returns Long[]

readArrayOfNullableInt8

Parameters

fieldName: string

Returns number[]

readArrayOfString

Parameters