FieldInput

fm.serializer.FieldInput
trait FieldInput extends NestedInput

FIELD Input

This the extra methods for reading FIELD input along with the NestedInput methods

Attributes

Graph
Supertypes
trait NestedInput
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Abstract methods

def allowStringMap: Boolean
def lastFieldName(): String

The last field name that was read (if any)

The last field name that was read (if any)

Attributes

def lastFieldNumber(): Int

The last field number that was read (if any)

The last field number that was read (if any)

Attributes

def readFieldName(): String

If dynamic string maps are supported then this should be implemented otherwise this can just throw an exception.

If dynamic string maps are supported then this should be implemented otherwise this can just throw an exception.

null should be returns on the end of an object/message

Attributes

def readFieldNumber(nameToNumMap: FieldNameToNumberLookup): Int

This is for reading fields of an object.

This is for reading fields of an object.

Return the field number for the next readable field. Returns 0 if we've reached the end of the object/message

Attributes

def skipUnknownField(): Unit

Skip an unknown field value.

Skip an unknown field value.

If after calling readFieldNumber(...) we don't know how to handle the resulting field number then this method can be called to skip the value of the field after which we can call readFieldNumber(...) again.

Attributes

Concrete methods

def reportUnsetField[T](number: Int, name: String, hasUserDefinedDefaultValue: Boolean, deserializer: Deserializer[T]): Unit

This is for reporting that fields for an object were not read and whether or not they had a user-defined default value.

This is for reporting that fields for an object were not read and whether or not they had a user-defined default value.

Value parameters

deserializer

The deserializer for the field. Note: This can be null.

hasUserDefinedDefaultValue

Whether or not there was a user defined default value (e.g. val foo: Int = 123)

name

The field name. Note: This can be null.

number

The field number

Attributes

Inherited methods

def nextValueIsNull: Boolean

Returns true if the next value is known to be null otherwise false if the value is not null or is unknown. This means that even if the next value ends up being null this can return false.

Returns true if the next value is known to be null otherwise false if the value is not null or is unknown. This means that even if the next value ends up being null this can return false.

Note: If the next value is null then this method should consume that input

Attributes

Inherited from:
NestedInput
def readNestedBigDecimal(): BigDecimal

Attributes

Inherited from:
NestedInput
def readNestedBigInteger(): BigInteger

Attributes

Inherited from:
NestedInput
def readNestedBool(): Boolean

Attributes

Inherited from:
NestedInput
def readNestedByteArray(): Array[Byte]

Attributes

Inherited from:
NestedInput

Attributes

Inherited from:
NestedInput
def readNestedDouble(): Double

Attributes

Inherited from:
NestedInput
def readNestedFixedInt(): Int

Attributes

Inherited from:
NestedInput
def readNestedFixedLong(): Long

Attributes

Inherited from:
NestedInput
def readNestedFloat(): Float

Attributes

Inherited from:
NestedInput
def readNestedInt(): Int

Attributes

Inherited from:
NestedInput
def readNestedLong(): Long

Attributes

Inherited from:
NestedInput
def readNestedObject[T](f: FieldInput => T): T

Attributes

Inherited from:
NestedInput
def readNestedSignedInt(): Int

Attributes

Inherited from:
NestedInput
def readNestedSignedLong(): Long

Attributes

Inherited from:
NestedInput
def readNestedString(): String

Attributes

Inherited from:
NestedInput

Attributes

Inherited from:
NestedInput

Attributes

Inherited from:
NestedInput