fm-serializer
API
Generated with
fm-serializer/fm.serializer/fm.serializer.validation/ValidationInput

ValidationInput

fm.serializer.validation.ValidationInput
See theValidationInput companion object
final class ValidationInput(self: Input, options: ValidationOptions) extends Input

This wraps an Input and provides validation information

Attributes

Companion
object
Graph
Supertypes
trait Input
trait RawInput
trait FieldInput
trait NestedInput
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def allowStringMap: Boolean

Attributes

Definition Classes
override def hasAnotherElement: Boolean

Is there another element to read in the collection?

Is there another element to read in the collection?

Attributes

Definition Classes
override def lastFieldName(): String

The last field name that was read (if any)

The last field name that was read (if any)

Attributes

Definition Classes
override def lastFieldNumber(): Int

The last field number that was read (if any)

The last field number that was read (if any)

Attributes

Definition Classes
override 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

Definition Classes
override 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

Definition Classes
override 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

Definition Classes
override def readNestedBigDecimal(): BigDecimal

Attributes

Definition Classes
override def readNestedBigInteger(): BigInteger

Attributes

Definition Classes
override def readNestedBool(): Boolean

Attributes

Definition Classes
override def readNestedByteArray(): Array[Byte]

Attributes

Definition Classes
override def readNestedCollection[T](f: CollectionInput => T): T

Attributes

Definition Classes
override def readNestedDouble(): Double

Attributes

Definition Classes
override def readNestedFixedInt(): Int

Attributes

Definition Classes
override def readNestedFixedLong(): Long

Attributes

Definition Classes
override def readNestedFloat(): Float

Attributes

Definition Classes
override def readNestedInt(): Int

Attributes

Definition Classes
override def readNestedLong(): Long

Attributes

Definition Classes
override def readNestedObject[T](f: FieldInput => T): T

Attributes

Definition Classes
override def readNestedSignedInt(): Int

Attributes

Definition Classes
override def readNestedSignedLong(): Long

Attributes

Definition Classes
override def readNestedString(): String

Attributes

Definition Classes
override def readNestedUnsignedInt(): Int

Attributes

Definition Classes
override def readNestedUnsignedLong(): Long

Attributes

Definition Classes
override def readRawBigDecimal(): BigDecimal

Attributes

Definition Classes
override def readRawBigInteger(): BigInteger

Attributes

Definition Classes
override def readRawBool(): Boolean

Attributes

Definition Classes
override def readRawByteArray(): Array[Byte]

Attributes

Definition Classes
override def readRawCollection[T](f: CollectionInput => T): T

Attributes

Definition Classes
override def readRawDouble(): Double

Attributes

Definition Classes
override def readRawFixedInt(): Int

Attributes

Definition Classes
override def readRawFixedLong(): Long

Attributes

Definition Classes
override def readRawFloat(): Float

Attributes

Definition Classes
override def readRawInt(): Int

Attributes

Definition Classes
override def readRawLong(): Long

Attributes

Definition Classes
override def readRawObject[T](f: FieldInput => T): T

Attributes

Definition Classes
override def readRawSignedInt(): Int

Attributes

Definition Classes
override def readRawSignedLong(): Long

Attributes

Definition Classes
override def readRawString(): String

Attributes

Definition Classes
override def readRawUnsignedInt(): Int

Attributes

Definition Classes
override def readRawUnsignedLong(): Long

Attributes

Definition Classes
override 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

Definition Classes
override 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

Definition Classes
Generated with