com.wix.accord.Descriptions

Conditional

case class Conditional(on: Description, value: Any, guard: Option[Description], target: Description) extends Description with Product with Serializable

Denotes that the desirable validation strategy depends on a runtime condition. For example, the following expression:

person.age match {
case age if age < 18 => person.guardian is notEmpty
case age if age >= 18 => person.residencyAddress is notEmpty
}

May evaluate to either of the following descriptions: - Conditional( on = AccessChain( "age" ), value = -5, guard = Some( Generic( "age < 18" ) ), target = AccessChain( "guardian" ) ) - Conditional( on = AccessChain( "age" ), value = 55, guard = Some( Generic( "age >= 18" ) ), target = AccessChain( "residencyAddress" ) )

on

A description of the property on which validation branches, or Generic( "Branch" ) if not applicable.

value

The runtime value of the condition for the matching case.

guard

An optional description of the guard specified for the matching case.

target

The description of the validation target for the matching case.

Linear Supertypes
Serializable, Serializable, Product, Equals, Description, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Conditional
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Description
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Conditional(on: Description, value: Any, guard: Option[Description], target: Description)

    on

    A description of the property on which validation branches, or Generic( "Branch" ) if not applicable.

    value

    The runtime value of the condition for the matching case.

    guard

    An optional description of the guard specified for the matching case.

    target

    The description of the validation target for the matching case.

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  9. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  11. val guard: Option[Description]

    An optional description of the guard specified for the matching case.

  12. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  13. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  16. val on: Description

    A description of the property on which validation branches, or Generic( "Branch" ) if not applicable.

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

    Definition Classes
    AnyRef

  18. val target: Description

    The description of the validation target for the matching case.

  19. val value: Any

    The runtime value of the condition for the matching case.

  20. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Description

Inherited from AnyRef

Inherited from Any

Ungrouped