implicit class Descriptor[U] extends AnyRef
Enables explicitly describing expression under validation.
After the macro transform, the resulting validator will use the specified description to render violations. See the as method for full example.
- U
The type of the provided expression.
- See also
com.wix.accord.dsl
- Alphabetic
- By Inheritance
- Descriptor
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
Descriptor(value: U)
- value
The value to wrap with an explicit description.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
as(description: String): U
Tags the specified validation expression with an explicit description.
Tags the specified validation expression with an explicit description. Enables syntax such as:
p.firstName as "first name" is notEmpty
; violations for this validation rule will be rendered with the specified expression (instead of the implicit rule), for example:--- TODO --- update example!
scala> case class Person( firstName: String, lastName: String ) defined class Person scala> implicit val personValidator = validator[ Person ] { p => p.firstName as "first name" is notEmpty } personValidator: com.wix.accord.combinators.And[Person] = <function1> scala> validate( Person( "", "last" ) ) res0: com.wix.accord.Result = Failure(List(Violation(first name must not be empty,)))
Without the explicit description, the violation would read "firstName must not be empty".
- description
The description to use for the expression in case of violations.
- returns
The validation expression tagged with the explicit description.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )