< Back

Packages

package root

Definition Classes
root
package com

Definition Classes
root
package wix

Definition Classes
com
package accord
The entry-point to the Accord library.
The entry-point to the Accord library.
Overview
An Accord validator is a typeclass, which adds data validation rules over an existing domain model. The api module deals with the usage site; details on how to define validators can be found in the core module.
To use a validator, simply import this package, make sure the validator is in scope and use the validate function:
```
scala> import com.wix.accord._
import com.wix.accord._

scala> import MyDomain._
import MyDomain._

scala> val person = Person( name = "Niklaus", surname = "Wirth", age = 81 )
person: MyDomain.Person = Person(Niklaus,Wirth,81)

scala> validate( person )
res0: com.wix.accord.Result = Success
```
See Result, Success and Failure for details of the result model.
Definition Classes
wix
BaseValidator
Descriptions
Failure
GroupViolation
Implicits
MaybeNullSafeValidator
NullSafeValidator
Nullability
Result
RuleViolation
Success
Validator
Violation
ViolationBuilder

t

Violation

sealed trait Violation extends AnyRef

A base trait for all violation types.

Linear Supertypes

AnyRef, Any

Known Subclasses

GroupViolation, RuleViolation

Ordering

Alphabetic
By Inheritance

Inherited

Violation
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Abstract Value Members

abstract def constraint: String
A textual description of the constraint being violated (for example, "must not be empty").
abstract def path: Path
The actual generated path of the object under validation (this is the expression that, when evaluated at runtime, produces the value in com.wix.accord.Violation.value).
The actual generated path of the object under validation (this is the expression that, when evaluated at runtime, produces the value in com.wix.accord.Violation.value). This is normally filled in by the validation transform macro, but can also be explicitly provided via the DSL.
abstract def value: Any
The actual runtime value of the object under validation.

Concrete 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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[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
@throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped