Object/Trait

com.twitter.finatra.validation

ValidationResult

Related Docs: trait ValidationResult | package validation

Permalink

object ValidationResult

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ValidationResult
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class Invalid(message: String, code: ErrorCode = ErrorCode.Unknown, path: Path = Path.Empty, annotation: Option[Annotation] = None) extends ValidationResult with Product with Serializable

    Permalink
  2. case class Valid(annotation: Option[Annotation] = None) extends ValidationResult with Product with Serializable

    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. final def asInstanceOf[T0]: T0

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. def validate(condition: ⇒ Boolean, message: ⇒ String, code: ErrorCode = ErrorCode.Unknown): ValidationResult

    Permalink

    Utility for evaluating a condition in order to return a ValidationResult.

    Utility for evaluating a condition in order to return a ValidationResult. Returns ValidationResult.Valid when the condition is true, otherwise if the condition evaluates to false or throws an exception a ValidationResult.Invalid will be returned. In the case of an exception, the exception.getMessage is used in place of the given message.

    condition

    function to evaluate for validation.

    message

    function to evaluate for a message when the given condition is false.

    code

    ErrorCode to use for when the given condition is false.

    returns

    a ValidationResult.Valid when the condition is true otherwise a ValidationResult.Invalid.

    Note

    This will not allow a non-fatal exception to escape. Instead a ValidationResult.Invalid will be returned when a non-fatal exception is encountered when evaluating condition. As this equates failure to execute the condition function to a return of false.

  18. def validateNot(condition: ⇒ Boolean, message: ⇒ String, code: ErrorCode = ErrorCode.Unknown): ValidationResult

    Permalink

    Utility for evaluating the negation of a condition in order to return a ValidationResult.

    Utility for evaluating the negation of a condition in order to return a ValidationResult. Returns ValidationResult.Valid when the condition is false, otherwise if the condition evaluates to true or throws an exception a ValidationResult.Invalid will be returned. In the case of an exception, the exception.getMessage is used in place of the given message.

    condition

    function to evaluate for validation.

    message

    function to evaluate for a message when the given condition is true.

    code

    ErrorCode to use for when the given condition is true.

    returns

    a ValidationResult.Valid when the condition is false or when the condition evaluation throws a NonFatal exception otherwise a ValidationResult.Invalid.

    Note

    This will not allow a non-fatal exception to escape. Instead a ValidationResult.Valid will be returned when a non-fatal exception is encountered when evaluating condition. As this equates failure to execute the condition to a return of false.

  19. final def wait(): Unit

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped