Descriptions

Type Members

1. sealed trait AssociativeDescription extends Description

   

   Trait for descriptions that are associated with another element (for example, indexed sequence access).

2. case class Branch(guard: Generic, evaluation: Boolean) extends AssociativeDescription with Product with Serializable

   

   Denotes that the desirable validation strategy depends of the result of an if statement.

   Denotes that the desirable validation strategy depends of the result of an if statement.

   For example, the following rule:

   if (person.age < 18)
     person.guardian is notEmpty
   else
     person.residencyAddress is notEmpty

   May evaluate to either of the following descriptions: - Branch( guard = Generic( "age < 18" ), evaluation = true ) - Branch( guard = Generic( "age < 18" ), evaluation = false )

   guard

   Describes the specified branch condition.

   evaluation

   THe result of evaluating the branch condition.

3. sealed trait Description extends AnyRef

   

   Root trait whose various cases describe a single Object Under Validation (OUV).

4. case class Explicit(description: String) extends Description with Product with Serializable

   

   Denotes an explicit textual description, typically provided via the DSL as keyword.

5. case class Generic(description: String) extends Description with Product with Serializable

   

   Denotes a generic textual description, typically a piece of code, where a better description could not be generated (for example: the field name as part of an com.wix.accord.Descriptions.AccessChain).

6. case class Indexed(index: Long) extends AssociativeDescription with Product with Serializable

   

   Denotes an index access (e.g.

   Denotes an index access (e.g. accessing the nth element of an array).

7. type Path = Seq[Description]

   

   Describes a "path" through the object graph, from the root to a specific object under validation.

   Describes a "path" through the object graph, from the root to a specific object under validation. The empty path refers to the root object itself (a "self reference").

8. case class PatternMatch(on: Path, value: Any, guard: Option[Generic]) extends AssociativeDescription with Product with Serializable

   

   Denotes that the desirable validation strategy depends on the result of a pattern match.

   Denotes that the desirable validation strategy depends on the result of a pattern match.

   For example, the following rule:

   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: - PatternMatch( on = AccessChain( "age" ), value = -5, guard = Some( Generic( "age < 18" ) ) ) - PatternMatch( on = AccessChain( "age" ), value = 55, guard = Some( Generic( "age >= 18" ) ) )

   on

   Describes the expression being matched on.

   value

   The value of the expression being matched on.

   guard

   Describes the guard (if clause) of the matching case, if applicable.