combinators

Type Members

class AnInstanceOf[T <: AnyRef] extends NullSafeValidator[AnyRef]

A validator that succeeds only if the validated object is an instance of the specified type.
class And[T] extends Validator[T]

A combinator that takes a chain of predicates and implements logical AND between them.
trait BooleanCombinators extends AnyRef

Simple boolean combinators.
trait CollectionCombinators extends AnyRef

Combinators that operate on collections and collection-like structures.
class Conditional[T] extends Validator[T]

A validator that branches at runtime based on the value of the object under validation.
class Empty[T <: AnyRef] extends NullSafeValidator[T]

A validator that operates on objects that can be empty, and succeeds only if the provided instance is empty.
class EndsWith extends NullSafeValidator[String]

A validator that succeeds only if the provided string starts with the specified suffix.
class EqualTo[T] extends Validator[T]

A validator that succeeds only if the validated object is equal to the specified value.
case class EquivalentTo[T](other: T, prefix: String)(implicit ev: Ordering[T]) extends BaseValidator[T] with Product with Serializable

A validator that succeeds only for value equivalent (as determined by scala.math.Ordering.equiv) to the specified bound.
class Fail[T] extends Validator[T]

A validator that always fails with a specific violation.
trait GeneralPurposeCombinators extends AnyRef

Non type-specific combinators.
case class GreaterThan[T](bound: T, prefix: String)(implicit ev: Ordering[T]) extends BaseValidator[T] with Product with Serializable

A validator that succeeds only for values greater than the specified bound.
case class GreaterThanOrEqual[T](bound: T, prefix: String)(implicit ev: Ordering[T]) extends BaseValidator[T] with Product with Serializable

A validator that succeeds only for values greater than, or equal to, the specified bound.
type HasEmpty = AnyRef { def isEmpty: Boolean }

A structural type representing any object that can be empty.
A structural type representing any object that can be empty.

Definition Classes
CollectionCombinators
case class In[T](set: Set[T], prefix: String) extends BaseValidator[T] with Product with Serializable

A validator that succeeds only if the object exists in the target collection.
sealed trait InRange[T] extends Validator[T]

A base trait for a validator that succeeds only for values between the specified bounds, and may be inclusive or exclusive.
case class InRangeExclusive[T](lowerBound: T, upperBound: T, prefix: String)(implicit ev: Ordering[T]) extends BaseValidator[T] with InRange[T] with Product with Serializable

A validator that succeeds only for values between the specified bounds (exclusive of the upper bound).
case class InRangeInclusive[T](lowerBound: T, upperBound: T, prefix: String)(implicit ev: Ordering[T]) extends BaseValidator[T] with InRange[T] with Product with Serializable

A validator that succeeds only for values between the specified bounds (both bounds are inclusive).
class IsFalse extends BaseValidator[Boolean]

A boolean validator that matches only on false.
class IsNotNull extends BaseValidator[AnyRef]

A validator that succeeds only if the provided object is not null.
class IsNull extends BaseValidator[AnyRef]

A validator that succeeds only if the provided object is null.
class IsTrue extends BaseValidator[Boolean]

A boolean validator that matches only on true.
case class LesserThan[T](bound: T, prefix: String)(implicit ev: Ordering[T]) extends BaseValidator[T] with Product with Serializable

A validator that succeeds only for values lesser than the specified bound.
case class LesserThanOrEqual[T](bound: T, prefix: String)(implicit ev: Ordering[T]) extends BaseValidator[T] with Product with Serializable

A validator that succeeds only for values less than, or equal to, the specified bound.
class MatchesRegex extends NullSafeValidator[String]

A validator that succeeds only if the provided string matches the specified pattern.
class NilValidator[T] extends Validator[T]

A validator that always succeeds.
class NotAnInstanceOf[T <: AnyRef] extends NullSafeValidator[AnyRef]

A validator that fails only if the validated object is an instance of the specified type.
class NotEmpty[T <: AnyRef] extends NullSafeValidator[T]

A validator that operates on objects that can be empty, and succeeds only if the provided instance is not empty.
class NotEqualTo[T] extends Validator[T]

A validator that succeeds only if the validated object is not equal to the specified value.
class Or[T] extends Validator[T]

A combinator that takes a chain of predicates and implements logical OR between them.
trait OrderingCombinators extends AnyRef

Provides combinators over objects implementing scala.math.Ordering.
class StartsWith extends NullSafeValidator[String]

A validator that succeeds only if the provided string starts with the specified prefix.
trait StringCombinators extends AnyRef

Combinators that operate specifically on strings.
class Valid[T] extends Validator[T]

A validator which merely delegates to another, implicitly available validator.

Value Members

object Distinct extends Validator[Traversable[_]]

A validator that succeeds only if the provided collection has no duplicate elements.
implicit def genericTraversableOnce2HasEmpty[T](gto: T)(implicit ev: (T) ⇒ GenTraversableOnce[_]): HasEmpty

An implicit conversion to enable any collection-like object (e.
An implicit conversion to enable any collection-like object (e.g. strings, options) to be handled by the com.wix.accord.combinators.CollectionCombinators.Empty and com.wix.accord.combinators.CollectionCombinators.NotEmpty combinators.
java.lang.String does not directly implement isEmpty (in practice it is implemented in scala.collection.IndexedSeqOptimized, via an implicit conversion and an inheritance stack), and this is a case where the Scala compiler does not always infer structural types correctly. By requiring a view bound from T to scala.collection.GenTraversableOnce we can force any collection-like structure to conform to the structural type com.wix.accord.combinators.HasEmpty, and by requiring a view bound from T to com.wix.accord.combinators.HasEmpty at the call site (e.g. com.wix.accord.dsl.empty) we additionally support any class that directly conforms to the structural type as well.
T
The type that conforms, directly or implicitly, to com.wix.accord.combinators.HasEmpty.
gto
An object that is, or is implicitly convertible to, scala.collection.GenTraversableOnce.
returns
The specified object, strictly-typed as com.wix.accord.combinators.HasEmpty.

Definition Classes
CollectionCombinators

package combinators

Type Members

class AnInstanceOf[T <: AnyRef] extends NullSafeValidator[AnyRef]

class And[T] extends Validator[T]

trait BooleanCombinators extends AnyRef

trait CollectionCombinators extends AnyRef

class Conditional[T] extends Validator[T]

class Empty[T <: AnyRef] extends NullSafeValidator[T]

class EndsWith extends NullSafeValidator[String]

class EqualTo[T] extends Validator[T]

case class EquivalentTo[T](other: T, prefix: String)(implicit ev: Ordering[T]) extends BaseValidator[T] with Product with Serializable

class Fail[T] extends Validator[T]

trait GeneralPurposeCombinators extends AnyRef

case class GreaterThan[T](bound: T, prefix: String)(implicit ev: Ordering[T]) extends BaseValidator[T] with Product with Serializable

case class GreaterThanOrEqual[T](bound: T, prefix: String)(implicit ev: Ordering[T]) extends BaseValidator[T] with Product with Serializable

type HasEmpty = AnyRef { def isEmpty: Boolean }

case class In[T](set: Set[T], prefix: String) extends BaseValidator[T] with Product with Serializable

sealed trait InRange[T] extends Validator[T]

case class InRangeExclusive[T](lowerBound: T, upperBound: T, prefix: String)(implicit ev: Ordering[T]) extends BaseValidator[T] with InRange[T] with Product with Serializable

case class InRangeInclusive[T](lowerBound: T, upperBound: T, prefix: String)(implicit ev: Ordering[T]) extends BaseValidator[T] with InRange[T] with Product with Serializable

class IsFalse extends BaseValidator[Boolean]

class IsNotNull extends BaseValidator[AnyRef]

class IsNull extends BaseValidator[AnyRef]

class IsTrue extends BaseValidator[Boolean]

case class LesserThan[T](bound: T, prefix: String)(implicit ev: Ordering[T]) extends BaseValidator[T] with Product with Serializable

case class LesserThanOrEqual[T](bound: T, prefix: String)(implicit ev: Ordering[T]) extends BaseValidator[T] with Product with Serializable

class MatchesRegex extends NullSafeValidator[String]

class NilValidator[T] extends Validator[T]

class NotAnInstanceOf[T <: AnyRef] extends NullSafeValidator[AnyRef]

class NotEmpty[T <: AnyRef] extends NullSafeValidator[T]

class NotEqualTo[T] extends Validator[T]

class Or[T] extends Validator[T]

trait OrderingCombinators extends AnyRef

class StartsWith extends NullSafeValidator[String]

trait StringCombinators extends AnyRef

class Valid[T] extends Validator[T]

Value Members

object Distinct extends Validator[Traversable[_]]

implicit def genericTraversableOnce2HasEmpty[T](gto: T)(implicit ev: (T) ⇒ GenTraversableOnce[_]): HasEmpty

Inherited from BooleanCombinators

Inherited from OrderingCombinators

Inherited from StringCombinators

Inherited from CollectionCombinators

Inherited from GeneralPurposeCombinators

Inherited from AnyRef

Inherited from Any

Ungrouped