com.wix.accord.combinators

OrderingCombinators

trait OrderingCombinators extends AnyRef

Provides combinators over objects implementing scala.math.Ordering.

Implementation note: All methods here should only require scala.math.PartialOrdering, but then the default implicits are defined in the scala.math.Ordering companion and would therefore not be imported by default at the call site.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. OrderingCombinators
  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 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.

    A validator that succeeds only for value equivalent (as determined by scala.math.Ordering.equiv) to the specified bound.

    T

    The object type this validator operates on.

    other

    The fixed value against which values are validated.

    prefix

    A prefix for violation messages; for example, specifying "got" will result in a constraint violation like "got 10, expected 5".

    ev

    Evidence that T is ordered (i.e. a scala.math.Ordering of T is available).

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

    A validator that succeeds only for values greater than the specified bound.

    T

    The object type this validator operates on.

    bound

    The bound against which values are validated.

    prefix

    A prefix for violation messages; for example, specifying "got" will result in a constraint violation like "got 5, expected more than 10".

    ev

    Evidence that T is ordered (i.e. a scala.math.Ordering of T is available).

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

    A validator that succeeds only for values greater than, or equal to, the specified bound.

    T

    The object type this validator operates on.

    bound

    The bound against which values are validated.

    prefix

    A prefix for violation messages; for example, specifying "got" will result in a constraint violation like "got 5, expected 10 or more".

    ev

    Evidence that T is ordered (i.e. a scala.math.Ordering of T is available).

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

    A base trait for a validator that succeeds only for values between the specified bounds, and may be inclusive or exclusive.

    T

    The object type this validator operates on.

  5. 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).

    A validator that succeeds only for values between the specified bounds (exclusive of the upper bound). The com.wix.accord.combinators.OrderingCombinators.InRange.inclusive method can be used to derive a validator that includes the upper bound.

    T

    The object type this validator operates on.

    lowerBound

    The lower bound against which values are validated.

    upperBound

    The lower bound against which values are validated.

    prefix

    A prefix for violation messages; for example, specifying "got" will result in a constraint violation like "got 10, expected between 5 and 7 (exclusively)".

    ev

    Evidence that T is ordered (i.e. a scala.math.Ordering of T is available).

  6. 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).

    A validator that succeeds only for values between the specified bounds (both bounds are inclusive). The com.wix.accord.combinators.OrderingCombinators.InRange.exclusive method can be used to derive a validator that excludes the upper bound.

    T

    The object type this validator operates on.

    lowerBound

    The lower bound against which values are validated.

    upperBound

    The lower bound against which values are validated.

    prefix

    A prefix for violation messages; for example, specifying "got" will result in a constraint violation like "got 10, expected between 5 and 7".

    ev

    Evidence that T is ordered (i.e. a scala.math.Ordering of T is available).

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

    A validator that succeeds only for values lesser than the specified bound.

    T

    The object type this validator operates on.

    bound

    The bound against which values are validated.

    prefix

    A prefix for violation messages; for example, specifying "got" will result in a constraint violation like "got 10, expected less than 10".

    ev

    Evidence that T is ordered (i.e. a scala.math.Ordering of T is available).

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

    A validator that succeeds only for values less than, or equal to, the specified bound.

    T

    The object type this validator operates on.

    bound

    The bound against which values are validated.

    prefix

    A prefix for violation messages; for example, specifying "got" will result in a constraint violation like "got 10, expected 5 or less".

    ev

    Evidence that T is ordered (i.e. a scala.math.Ordering of T is available).

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

    Definition Classes
    Any

  5. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  12. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  16. def toString(): String

    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  18. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped