com.wix.accord

Descriptions

object Descriptions

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Descriptions
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class AccessChain(elements: Description*) extends Description with Product with Serializable

    Denotes an indirection chain.

    Denotes an indirection chain. For example, the expression field.subfield.subsubfield would result in a description like AccessChain( Generic( "field" ), Generic( "subfield" ), Generic( "subsubfield" ) ).

  2. 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.

    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.

  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, of: Description = Empty) extends Description with Product with Serializable

    Denotes an index access (e.

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

Value Members

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

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

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

    Definition Classes
    AnyRef → Any
  4. object Empty extends Description with Product with Serializable

    An empty (i.

    An empty (i.e. unknown) description. This is the default state of any violation prior to applying additional information via com.wix.accord.Descriptions.combine.

  5. object SelfReference extends Description with Product with Serializable

    Denotes a self-reference (i.

    Denotes a self-reference (i.e. using a single positional wildcard in a lambda).

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val combine: (Description, Description) ⇒ Description

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

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

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

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

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

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

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

    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  18. val render: (Description) ⇒ String

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

    Definition Classes
    AnyRef
  20. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped