Interface PortableReader

Reader helper for Portable objects.

Hierarchy

PortableReader

Methods

getFieldNames

getFieldNames(): string[]
Returns
set of field names on this Portable class

Returns string[]
- Defined in src/serialization/Portable.ts:376

getFieldType

getFieldType(fieldName: string): FieldType
Returns
field type of given fieldName

Throws
RangeError if the field does not exist.
Parameters
- fieldName: string
  
  name of the field
Returns FieldType
- Defined in src/serialization/Portable.ts:383

getVersion

getVersion(): number
Returns
global version of Portable classes

Returns number
- Defined in src/serialization/Portable.ts:365

hasField

hasField(fieldName: string): boolean
Returns
true if field exist in this class.
Parameters
- fieldName: string
  
  name of the field (does not support nested paths)
Returns boolean
- Defined in src/serialization/Portable.ts:371

readBoolean

readBoolean(fieldName: string): boolean
Reads a primitive boolean.

Returns
the boolean value read
Parameters
- fieldName: string
  
  name of the field
Returns boolean
- Defined in src/serialization/Portable.ts:424

readBooleanArray

readBooleanArray(fieldName: string): boolean[]
Reads an array of primitive booleans.

Returns
the boolean array value read
Parameters
- fieldName: string
  
  name of the field
Returns boolean[]
- Defined in src/serialization/Portable.ts:528

readByte

readByte(fieldName: string): number
Reads a 8-bit unsigned integer.

Returns
the byte value read
Parameters
- fieldName: string
  
  name of the field
Returns number
- Defined in src/serialization/Portable.ts:432

readByteArray

readByteArray(fieldName: string): Buffer
Reads an array of bytes.

Returns
the byte array value read
Parameters
- fieldName: string
  
  name of the field
Returns Buffer
- Defined in src/serialization/Portable.ts:520

readChar

readChar(fieldName: string): string
Reads a single character string using String.fromCharCode from two bytes of UTF-16 code units.

Returns
the char value read
Parameters
- fieldName: string
  
  name of the field
Returns string
- Defined in src/serialization/Portable.ts:440

readCharArray

readCharArray(fieldName: string): string[]
Reads an array of single character strings. Each of them are read using String.fromCharCode from a two bytes UTF-16 code units.

Returns
the char array value read
Parameters
- fieldName: string
  
  name of the field
Returns string[]
- Defined in src/serialization/Portable.ts:537

readDate

readDate(fieldName: string): LocalDate
Reads a date.

Returns
the LocalDate value read
Parameters
- fieldName: string
  
  name of the field
Returns LocalDate
- Defined in src/serialization/Portable.ts:496

readDateArray

readDateArray(fieldName: string): LocalDate[]
Reads an array of LocalDates.

Returns
the LocalDate array read

See
readDate
Parameters
- fieldName: string
  
  name of the field
Returns LocalDate[]
- Defined in src/serialization/Portable.ts:629

readDecimal

readDecimal(fieldName: string): BigDecimal
Reads a decimal.

Returns
the BigDecimal value read
Parameters
- fieldName: string
  
  name of the field
Returns BigDecimal
- Defined in src/serialization/Portable.ts:480

readDecimalArray

readDecimalArray(fieldName: string): BigDecimal[]
Reads an array of BigDecimals.

Returns
the BigDecimal array read

See
readDecimal
Parameters
- fieldName: string
  
  name of the field
Returns BigDecimal[]
- Defined in src/serialization/Portable.ts:611

readDouble

readDouble(fieldName: string): number
Reads a double.

Returns
the double value read
Parameters
- fieldName: string
  
  name of the field
Returns number
- Defined in src/serialization/Portable.ts:448

readDoubleArray

readDoubleArray(fieldName: string): number[]
Reads an array of doubles.

Returns
the double array value read
Parameters
- fieldName: string
  
  name of the field
Returns number[]
- Defined in src/serialization/Portable.ts:561

readFloat

readFloat(fieldName: string): number
Reads a float.

Returns
the float value read
Parameters
- fieldName: string
  
  name of the field
Returns number
- Defined in src/serialization/Portable.ts:456

readFloatArray

readFloatArray(fieldName: string): number[]
Reads an array of floats.

Returns
the float array value read
Parameters
- fieldName: string
  
  name of the field
Returns number[]
- Defined in src/serialization/Portable.ts:569

readInt

readInt(fieldName: string): number
Reads a 32-bit signed integer.

Returns
the int value read
Parameters
- fieldName: string
  
  name of the field
Returns number
- Defined in src/serialization/Portable.ts:391

readIntArray

readIntArray(fieldName: string): number[]
Reads an array of 32-bit signed integers.

Returns
the int array value read
Parameters
- fieldName: string
  
  name of the field
Returns number[]
- Defined in src/serialization/Portable.ts:545

readLong

readLong(fieldName: string): Long
Reads a long.

Returns
the long value read
Parameters
- fieldName: string
  
  name of the field
Returns Long
- Defined in src/serialization/Portable.ts:399

readLongArray

readLongArray(fieldName: string): Long[]
Reads an array of longs.

Returns
the long array value read
Parameters
- fieldName: string
  
  name of the field
Returns Long[]
- Defined in src/serialization/Portable.ts:553

readPortable

readPortable(fieldName: string): Portable
Reads a Portable.

Returns
the Portable value read
Parameters
- fieldName: string
  
  name of the field
Returns Portable
- Defined in src/serialization/Portable.ts:472

readPortableArray

readPortableArray(fieldName: string): Portable[]
Reads an array of Portables.

Returns
the Portable array read
Parameters
- fieldName: string
  
  name of the field
Returns Portable[]
- Defined in src/serialization/Portable.ts:602

readShort

readShort(fieldName: string): number
Reads a 16-bit signed integer.

Returns
the short value read
Parameters
- fieldName: string
  
  name of the field
Returns number
- Defined in src/serialization/Portable.ts:464

readShortArray

readShortArray(fieldName: string): number[]
Reads an array of 16-bit signed integers.

Returns
the short array value read
Parameters
- fieldName: string
  
  name of the field
Returns number[]
- Defined in src/serialization/Portable.ts:577

readString

readString(fieldName: string): string
Reads a string from UTF-8 encoded bytes.

Returns
the string value read
Parameters
- fieldName: string
  
  name of the field
Returns string
- Defined in src/serialization/Portable.ts:416

readStringArray

readStringArray(fieldName: string): string[]
Reads an array of strings. Strings are read using UTF-8 encoding.

Returns
the string array value read
Parameters
- fieldName: string
  
  name of the field
Returns string[]
- Defined in src/serialization/Portable.ts:594

readTime

readTime(fieldName: string): LocalTime
Reads a time.

Returns
the LocalTime value read
Parameters
- fieldName: string
  
  name of the field
Returns LocalTime
- Defined in src/serialization/Portable.ts:488

readTimeArray

readTimeArray(fieldName: string): LocalTime[]
Reads an array of LocalTimes.

Returns
the LocalTime array read

See
readTime
Parameters
- fieldName: string
  
  name of the field
Returns LocalTime[]
- Defined in src/serialization/Portable.ts:620

readTimestamp

readTimestamp(fieldName: string): LocalDateTime
Reads a timestamp.

Returns
the LocalDateTime value read
Parameters
- fieldName: string
  
  name of the field
Returns LocalDateTime
- Defined in src/serialization/Portable.ts:504

readTimestampArray

readTimestampArray(fieldName: string): LocalDateTime[]
Reads an array of LocalDateTimes.

Returns
the LocalDateTime array read

See
readTimestamp
Parameters
- fieldName: string
  
  name of the field
Returns LocalDateTime[]
- Defined in src/serialization/Portable.ts:638

readTimestampWithTimezone

readTimestampWithTimezone(fieldName: string): OffsetDateTime
Reads a timestamp with timezone.

Returns
the OffsetDateTime value read
Parameters
- fieldName: string
  
  name of the field
Returns OffsetDateTime
- Defined in src/serialization/Portable.ts:512

readTimestampWithTimezoneArray

readTimestampWithTimezoneArray(fieldName: string): OffsetDateTime[]
Reads an array of OffsetDateTimes.

Returns
the OffsetDateTime array read

See
readTimestampWithTimezone
Parameters
- fieldName: string
  
  name of the field
Returns OffsetDateTime[]
- Defined in src/serialization/Portable.ts:647

readUTF

readUTF(fieldName: string): string
Reads a string from UTF-8 encoded bytes.

Returns
the UTF string value read

Deprecated
since version 4.2 for the sake of better naming. Please use readString instead.
Parameters
- fieldName: string
  
  name of the field
Returns string
- Defined in src/serialization/Portable.ts:408

readUTFArray

readUTFArray(fieldName: string): string[]
Reads an array strings. Strings are read using UTF-8 encoding.

Returns
the string array value read

Deprecated
since version 4.2 for the sake of better naming. Please use readStringArray instead
Parameters
- fieldName: string
  
  name of the field
Returns string[]
- Defined in src/serialization/Portable.ts:586

Generated using TypeDoc