Class/Object

fm.serializer.validation

ValidationInput

Related Docs: object ValidationInput | package validation

Permalink

final class ValidationInput extends Input

This wraps an Input and provides validation information

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ValidationInput
  2. Input
  3. RawInput
  4. CollectionInput
  5. FieldInput
  6. NestedInput
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ValidationInput(self: Input, options: ValidationOptions)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def allowStringMap: Boolean

    Permalink
    Definition Classes
    ValidationInputRawInputFieldInputNestedInput
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hasAnotherElement: Boolean

    Permalink

    Is there another element to read in the collection?

    Is there another element to read in the collection?

    Definition Classes
    ValidationInputCollectionInput
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. def lastFieldName(): String

    Permalink

    The last field name that was read (if any)

    The last field name that was read (if any)

    Definition Classes
    ValidationInputFieldInput
  15. def lastFieldNumber(): Int

    Permalink

    The last field number that was read (if any)

    The last field number that was read (if any)

    Definition Classes
    ValidationInputFieldInput
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def nextValueIsNull: Boolean

    Permalink

    Returns true if the next value is known to be null otherwise false if the value is not null or is unknown.

    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

    Definition Classes
    ValidationInputRawInputNestedInput
  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. def readFieldName(): String

    Permalink

    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

    Definition Classes
    ValidationInputFieldInput
  21. def readFieldNumber(nameToNumMap: FieldNameToNumberLookup): Int

    Permalink

    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

    Definition Classes
    ValidationInputFieldInput
  22. def readNestedBigDecimal(): BigDecimal

    Permalink
    Definition Classes
    ValidationInputNestedInput
  23. def readNestedBigInteger(): BigInteger

    Permalink
    Definition Classes
    ValidationInputNestedInput
  24. def readNestedBool(): Boolean

    Permalink
    Definition Classes
    ValidationInputNestedInput
  25. def readNestedByteArray(): Array[Byte]

    Permalink
    Definition Classes
    ValidationInputNestedInput
  26. def readNestedCollection[T](f: (CollectionInput) ⇒ T): T

    Permalink
    Definition Classes
    ValidationInputNestedInput
  27. def readNestedDouble(): Double

    Permalink
    Definition Classes
    ValidationInputNestedInput
  28. def readNestedFixedInt(): Int

    Permalink
    Definition Classes
    ValidationInputNestedInput
  29. def readNestedFixedLong(): Long

    Permalink
    Definition Classes
    ValidationInputNestedInput
  30. def readNestedFloat(): Float

    Permalink
    Definition Classes
    ValidationInputNestedInput
  31. def readNestedInt(): Int

    Permalink
    Definition Classes
    ValidationInputNestedInput
  32. def readNestedLong(): Long

    Permalink
    Definition Classes
    ValidationInputNestedInput
  33. def readNestedObject[T](f: (FieldInput) ⇒ T): T

    Permalink
    Definition Classes
    ValidationInputNestedInput
  34. def readNestedSignedInt(): Int

    Permalink
    Definition Classes
    ValidationInputNestedInput
  35. def readNestedSignedLong(): Long

    Permalink
    Definition Classes
    ValidationInputNestedInput
  36. def readNestedString(): String

    Permalink
    Definition Classes
    ValidationInputNestedInput
  37. def readNestedUnsignedInt(): Int

    Permalink
    Definition Classes
    ValidationInputNestedInput
  38. def readNestedUnsignedLong(): Long

    Permalink
    Definition Classes
    ValidationInputNestedInput
  39. def readRawBigDecimal(): BigDecimal

    Permalink
    Definition Classes
    ValidationInputRawInput
  40. def readRawBigInteger(): BigInteger

    Permalink
    Definition Classes
    ValidationInputRawInput
  41. def readRawBool(): Boolean

    Permalink
    Definition Classes
    ValidationInputRawInput
  42. def readRawByteArray(): Array[Byte]

    Permalink
    Definition Classes
    ValidationInputRawInput
  43. def readRawCollection[T](f: (CollectionInput) ⇒ T): T

    Permalink
    Definition Classes
    ValidationInputRawInput
  44. def readRawDouble(): Double

    Permalink
    Definition Classes
    ValidationInputRawInput
  45. def readRawFixedInt(): Int

    Permalink
    Definition Classes
    ValidationInputRawInput
  46. def readRawFixedLong(): Long

    Permalink
    Definition Classes
    ValidationInputRawInput
  47. def readRawFloat(): Float

    Permalink
    Definition Classes
    ValidationInputRawInput
  48. def readRawInt(): Int

    Permalink
    Definition Classes
    ValidationInputRawInput
  49. def readRawLong(): Long

    Permalink
    Definition Classes
    ValidationInputRawInput
  50. def readRawObject[T](f: (FieldInput) ⇒ T): T

    Permalink
    Definition Classes
    ValidationInputRawInput
  51. def readRawSignedInt(): Int

    Permalink
    Definition Classes
    ValidationInputRawInput
  52. def readRawSignedLong(): Long

    Permalink
    Definition Classes
    ValidationInputRawInput
  53. def readRawString(): String

    Permalink
    Definition Classes
    ValidationInputRawInput
  54. def readRawUnsignedInt(): Int

    Permalink
    Definition Classes
    ValidationInputRawInput
  55. def readRawUnsignedLong(): Long

    Permalink
    Definition Classes
    ValidationInputRawInput
  56. def reportUnsetField[T](number: Int, name: String, hasUserDefinedDefaultValue: Boolean, deserializer: Deserializer[T]): Unit

    Permalink

    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.

    number

    The field number

    name

    The field name. Note: This can be null.

    hasUserDefinedDefaultValue

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

    deserializer

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

    Definition Classes
    ValidationInputFieldInput
  57. def result(): ValidationResult

    Permalink
  58. def skipUnknownField(): Unit

    Permalink

    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.

    Definition Classes
    ValidationInputFieldInput
  59. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  60. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  61. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Input

Inherited from RawInput

Inherited from CollectionInput

Inherited from FieldInput

Inherited from NestedInput

Inherited from AnyRef

Inherited from Any

Ungrouped