Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Hierarchy

  • CompactReader

Index

Methods

  • readArrayOfBoolean(fieldName: string): boolean[]
  • Reads an array of booleans.

    This method can also read an array of nullable booleans, as long as it does not contain null values. If a null array item is read with this method, HazelcastSerializationError is thrown.

    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<T>(fieldName: string): T[]
  • readArrayOfDate(fieldName: string): LocalDate[]
  • readArrayOfDecimal(fieldName: string): BigDecimal[]
  • readArrayOfFloat32(fieldName: string): number[]
  • Reads an array of 32-bit IEEE 754 floating point numbers.

    This method can also read an array of nullable float32s, as long as it does not contain null values. If a null array item is read with this method, HazelcastSerializationError is thrown.

    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(fieldName: string): number[]
  • Reads an array of 64-bit IEEE 754 floating point numbers.

    This method can also read an array of nullable float64s, as long as it does not contain null values. If a null array item is read with this method, HazelcastSerializationError is thrown.

    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(fieldName: string): number[]
  • Reads an array of 16-bit two's complement signed integers.

    This method can also read an array of nullable int16s, as long as it does not contain null values. If a null array item is read with this method, HazelcastSerializationError is thrown.

    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(fieldName: string): number[]
  • Reads an array of 32-bit two's complement signed integers.

    This method can also read an array of nullable int32s, as long as it does not contain null values. If a null array item is read with this method, HazelcastSerializationError is thrown.

    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(fieldName: string): Long[]
  • Reads an array of 64-bit two's complement signed integers.

    This method can also read an array of nullable int64s, as long as it does not contain null values. If a null array item is read with this method, HazelcastSerializationError is thrown.

    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(fieldName: string): Buffer
  • Reads an array of 8-bit two's complement signed integers.

    This method can also read an array of nullable int8s, as long as it does not contain null values. If a null array item is read with this method, HazelcastSerializationError is thrown.

    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(fieldName: string): boolean[]
  • Reads a nullable array of nullable booleans.

    This method can also read array of non-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(fieldName: string): number[]
  • Reads a nullable array of nullable 32-bit IEEE 754 floating point numbers.

    This method can also read array of non-nullable float32s.

    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(fieldName: string): number[]
  • Reads a nullable array of nullable 64-bit IEEE 754 floating point numbers.

    This method can also read array of non-nullable float64s.

    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(fieldName: string): number[]
  • Reads a nullable array of nullable 16-bit two's complement signed integers.

    This method can also read array of non-nullable int16s.

    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(fieldName: string): number[]
  • Reads a nullable array of nullable 32-bit two's complement signed integers.

    This method can also read array of non-nullable int32s.

    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(fieldName: string): Long[]
  • Reads a nullable array of nullable 64-bit two's complement signed integers.

    This method can also read array of non-nullable int64s.

    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(fieldName: string): number[]
  • Reads a nullable array of nullable 8-bit two's complement signed integers.

    This method can also read array of non-nullable int8s.

    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(fieldName: string): string[]
  • readArrayOfTime(fieldName: string): LocalTime[]
  • readBoolean(fieldName: string): boolean
  • readCompact<T>(fieldName: string): T
  • readFloat32(fieldName: string): number
  • readFloat64(fieldName: string): number
  • readInt16(fieldName: string): number
  • Reads a 16-bit two's complement signed integer.

    This method can also read a nullable int16, as long as it is not null. If a null value is read with this method, HazelcastSerializationError is thrown.

    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(fieldName: string): number
  • Reads a 32-bit two's complement signed integer.

    This method can also read a nullable int32, as long as it is not null. If a null value is read with this method, HazelcastSerializationError is thrown.

    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(fieldName: string): Long
  • readInt8(fieldName: string): number
  • readNullableBoolean(fieldName: string): boolean
  • Reads a nullable boolean.

    This method can also read a non-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(fieldName: string): number
  • Reads a nullable 32-bit IEEE 754 floating point number.

    This method can also read a non-nullable float32.

    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(fieldName: string): number
  • Reads a nullable 64-bit IEEE 754 floating point number.

    This method can also read a non-nullable float64.

    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(fieldName: string): number
  • Reads a nullable 16-bit two's complement signed integer.

    This method can also read a non-nullable int16.

    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(fieldName: string): number
  • Reads a nullable 32-bit two's complement signed integer.

    This method can also read a non-nullable int32.

    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(fieldName: string): Long
  • Reads a nullable 64-bit two's complement signed integer.

    This method can also read a non-nullable int64.

    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(fieldName: string): number
  • Reads a nullable 8-bit two's complement signed integer.

    This method can also read a non-nullable int8.

    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(fieldName: string): string

Generated using TypeDoc