Trait/Object

io.finch

ValidationRule

Related Docs: object ValidationRule | package finch

Permalink

trait ValidationRule[A] extends AnyRef

A ValidationRule enables a reusable way of defining a validation rules in the application domain. It might be composed with Endpoints using either should or shouldNot methods and with other ValidationRules using logical methods and and or.

case class User(name: String, age: Int)
val user: Endpoint[User] = (
  param("name").validate(beLongerThan(3)) ::
  param("age").as[Int].should(beGreaterThan(0) and beLessThan(120))
).as[User]
Self Type
ValidationRule[A]
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ValidationRule
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def apply(value: A): Boolean

    Permalink

    Applies the rule to the specified value.

    Applies the rule to the specified value.

    returns

    true if the predicate of this rule holds for the specified value

  2. abstract def description: String

    Permalink

    Text description of this validation rule.

Concrete 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 and(that: ValidationRule[A]): ValidationRule[A]

    Permalink

    Combines this rule with another rule such that the new rule only validates if both the combined rules validate.

    Combines this rule with another rule such that the new rule only validates if both the combined rules validate.

    that

    the rule to combine with this rule

    returns

    a new rule that only validates if both the combined rules validate

  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 hashCode(): Int

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  16. def or(that: ValidationRule[A]): ValidationRule[A]

    Permalink

    Combines this rule with another rule such that the new rule validates if any one of the combined rules validates.

    Combines this rule with another rule such that the new rule validates if any one of the combined rules validates.

    that

    the rule to combine with this rule

    returns

    a new rule that validates if any of the combined rules validates

  17. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  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