RequireUtils

Type Members

type RequireElementFunction[T] = (T, String, Int) ⇒ Unit

Takes the element value, the name and the index as parameters and invokes RequireUtils#fail if requirements isn't satisfied.
type RequireFunction[T] = (T, String) ⇒ Unit

Takes the value and the name as parameters and invokes RequireUtils#fail if requirements isn't satisfied.

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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def fail(message: ⇒ Any): Unit

Fails test.
Fails test. Must be invoked at every time when requireXXX method fails. Default implementation throws an IllegalArgumentException with message built by RequireUtils#failureMessage method.
Override this implementation if you want another failure behaviour of all requireXXX methods of this objects.
For example if you want to throw MyApiException use this code:
```
override def fail(message: => Any) = {
  throw new MyApiException(failureMessage(message))
}
```
message
a String to include in the failure message

Annotations
@inline()
def failureMessage(message: ⇒ Any): String

Builds the failure message of any requireXXX method.
Builds the failure message of any requireXXX method. Default implementation concatenates prefix returned by RequireUtils#prefix method followed by message followed by postfix returned by RequireUtils#postfix method.
Override this implementation if you want to intercept or change rules of building failure messages.
message
the source message
returns
the failure message

Annotations
@inline()
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def optional[T](value: Option[T])(require: (T) ⇒ Unit): Unit

Invokes require function if value is Some(_) and do nothing otherwise.
Invokes require function if value is Some(_) and do nothing otherwise.
T
the type of value
value
the value
require
the function

Annotations
@inline()
def postfix: String

returns
the postfix of any requireXXX method failure message string

Annotations
@inline()
def prefix: String

returns
the prefix of any requireXXX method failure message string

Annotations
@inline()
def require(requirement: Boolean, message: ⇒ Any): Unit

Tests an expression, invoking RequireUtils#fail if false.
Tests an expression, invoking RequireUtils#fail if false.
requirement
the expression to test
message
a String to include in the failure message

Annotations
@inline()
def requireAll[T](value: Iterable[T], name: String = NoNameParameter)(require: RequireElementFunction[T]): Unit

Tests that all elements of iterable value satisfy the predicate, and otherwise throws IllegalArgumentException.
Tests that all elements of iterable value satisfy the predicate, and otherwise throws IllegalArgumentException.
T
the type of iterable elements
value
the iterable value
name
the name to include in the failure message
require
the function

Annotations
@inline()
def requireAllNotBlank(value: Iterable[String], name: String = NoNameParameter): Unit

Tests that iterable value does not contain blank (null or empty) strings, and otherwise throws IllegalArgumentException.
Tests that iterable value does not contain blank (null or empty) strings, and otherwise throws IllegalArgumentException.
value
the iterable value
name
the name to include in the failure message

Annotations
@inline()
def requireAllNotNull[T <: AnyRef](value: Iterable[T], name: String = NoNameParameter): Unit

Tests that iterable value does not contain null values, and otherwise throws IllegalArgumentException.
Tests that iterable value does not contain null values, and otherwise throws IllegalArgumentException.
T
the type of iterable elements
value
the iterable value
name
the name to include in the failure message

Annotations
@inline()
def requireAtLeastOneOf[T](value: Iterable[T], name: String = NoNameParameter)(seq: Iterable[T], allowDups: Boolean = false): Unit

Tests that at least one of elems of seq is contained in value
Tests that at least one of elems of seq is contained in value
T
the type of value
value
the value
name
the name to include in the failure message
seq
the sequence of values
allowDups
is allow duplicates

Annotations
@inline()
def requireByte(value: String, name: String = NoNameParameter): Unit

Tests that value is a Byte number string, and otherwise throws IllegalArgumentException.
Tests that value is a Byte number string, and otherwise throws IllegalArgumentException.
value
the value to test
name
the name to include in the failure message

Annotations
@inline()
def requireDouble(value: String, name: String = NoNameParameter): Unit

Tests that value is a Double number string, and otherwise throws IllegalArgumentException.
Tests that value is a Double number string, and otherwise throws IllegalArgumentException.
value
the value to test
name
the name to include in the failure message

Annotations
@inline()
def requireEmail(email: String, name: String = NoNameParameter): Unit

Tests that string email is a correct email address.
Tests that string email is a correct email address.
email
the testing email string
name
the name to include in the failure message

Annotations
@inline()
def requireFloat(value: String, name: String = NoNameParameter): Unit

Tests that value is a Float number string, and otherwise throws IllegalArgumentException.
Tests that value is a Float number string, and otherwise throws IllegalArgumentException.
value
the value to test
name
the name to include in the failure message

Annotations
@inline()
def requireInt(value: String, name: String = NoNameParameter): Unit

Tests that value is an Int number string, and otherwise throws IllegalArgumentException.
Tests that value is an Int number string, and otherwise throws IllegalArgumentException.
value
the value to test
name
the name to include in the failure message

Annotations
@inline()
def requireLong(value: String, name: String = NoNameParameter): Unit

Tests that value is a Long number string, and otherwise throws IllegalArgumentException.
Tests that value is a Long number string, and otherwise throws IllegalArgumentException.
value
the value to test
name
the name to include in the failure message

Annotations
@inline()
def requireNegative[T](value: T, name: String = NoNameParameter)(implicit arg0: Numeric[T]): Unit

Tests that value is negative, and otherwise throws IllegalArgumentException.
Tests that value is negative, and otherwise throws IllegalArgumentException.
value
the value to test
name
the name to include in the failure message

Annotations
@inline()
def requireNonNegative[T](value: T, name: String = NoNameParameter)(implicit arg0: Numeric[T]): Unit

Tests that value is positive or zero, and otherwise throws IllegalArgumentException.
Tests that value is positive or zero, and otherwise throws IllegalArgumentException.
value
the value to test
name
the name to include in the failure message

Annotations
@inline()
def requireNonPositive[T](value: T, name: String = NoNameParameter)(implicit arg0: Numeric[T]): Unit

Tests that value is negative or zero, and otherwise throws IllegalArgumentException.
Tests that value is negative or zero, and otherwise throws IllegalArgumentException.
value
the value to test
name
the name to include in the failure message

Annotations
@inline()
def requireNotBlank[T](value: Iterable[T]): Unit

Tests that sequence value isn't null or empty, and otherwise throws IllegalArgumentException.
Tests that sequence value isn't null or empty, and otherwise throws IllegalArgumentException.
T
the type of iterable elements
value
the iterable to test

Annotations
@inline()
def requireNotBlank[T](value: Iterable[T], name: String): Unit

Tests that sequence value isn't null or empty, and otherwise throws IllegalArgumentException.
Tests that sequence value isn't null or empty, and otherwise throws IllegalArgumentException.
T
the type of iterable elements
value
the iterable to test
name
the name to include in the failure message

Annotations
@inline()
def requireNotBlank(value: String, name: String = NoNameParameter): Unit

Tests that value isn't null or empty (after trim), and otherwise throws IllegalArgumentException.
Tests that value isn't null or empty (after trim), and otherwise throws IllegalArgumentException.
value
the value to test
name
the name to include in the failure message

Annotations
@inline()
def requireNotNull(value: AnyRef, name: String = NoNameParameter): Unit

Tests that value isn't null, and otherwise throws IllegalArgumentException.
Tests that value isn't null, and otherwise throws IllegalArgumentException.
value
the value to test
name
the name to include in the failure message

Annotations
@inline()
def requireNumber[T](value: T, name: String = NoNameParameter)(number: T)(implicit arg0: Numeric[T]): Unit

Test that value is equal to number, and otherwise throws IllegalArgumentException.
Test that value is equal to number, and otherwise throws IllegalArgumentException.
T
the type of iterable elements
value
the value
number
the required number

Annotations
@inline()
def requireNumberFrom[T](value: T, name: String = NoNameParameter)(leftBound: T, leftBoundType: BoundType = Inclusive)(implicit arg0: Numeric[T]): Unit

Tests that value is from leftBound with bound type leftBoundType until maximum value of type T (inclusive).
Tests that value is from leftBound with bound type leftBoundType until maximum value of type T (inclusive).
T
the type of value
value
the value
leftBound
the left bound
leftBoundType
the left bound type

Annotations
@inline()
def requireNumberFromExclusive[T](value: T, name: String = NoNameParameter)(leftBound: T)(implicit arg0: Numeric[T]): Unit

Tests that value is from leftBound (exclusive) until maximum value of type T (inclusive).
Tests that value is from leftBound (exclusive) until maximum value of type T (inclusive).
T
the type of value
value
the value
leftBound
the left bound

Annotations
@inline()
def requireNumberInRange[T](value: T, name: String = NoNameParameter)(leftBound: T, leftBoundType: BoundType = Inclusive)(rightBound: T, rightBoundType: BoundType = Exclusive)(implicit arg0: Numeric[T]): Unit

Tests that value is from leftBound with bound type leftBoundType until rightBound with bound type rightBoundType.
Tests that value is from leftBound with bound type leftBoundType until rightBound with bound type rightBoundType.
T
the type of value
value
the value
leftBound
the left bound
leftBoundType
the left bound type
rightBound
the right bound
rightBoundType
the right bound type

Annotations
@inline()
def requireNumberInterval[T](value: T, name: String = NoNameParameter)(leftBound: T, rightBound: T)(implicit arg0: Numeric[T]): Unit

Tests that value is from leftBound (exclusive) until rightBound (exclusive).
Tests that value is from leftBound (exclusive) until rightBound (exclusive).
T
the type of value
value
the value
leftBound
the left bound
rightBound
the right bound

Annotations
@inline()
def requireNumberSegment[T](value: T, name: String = NoNameParameter)(leftBound: T, rightBound: T)(implicit arg0: Numeric[T]): Unit

Tests that value is from leftBound (inclusive) until rightBound (inclusive).
Tests that value is from leftBound (inclusive) until rightBound (inclusive).
T
the type of value
value
the value
leftBound
the left bound
rightBound
the right bound

Annotations
@inline()
def requireNumberUntil[T](value: T, name: String = NoNameParameter)(rightBound: T, rightBoundType: BoundType = Exclusive)(implicit arg0: Numeric[T]): Unit

Tests that value is from minimum value of type T (inclusive) until rightBound with bound type rightBoundType.
Tests that value is from minimum value of type T (inclusive) until rightBound with bound type rightBoundType.
T
the type of value
value
the value
rightBound
the right bound
rightBoundType
the right bound type

Annotations
@inline()
def requireOnlyOneOf[T](value: Iterable[T], name: String = NoNameParameter)(seq: Iterable[T], allowDups: Boolean = false): Unit

Tests that one and only one of elems of seq is contained in value
Tests that one and only one of elems of seq is contained in value
T
the type of value
value
the value
name
the name to include in the failure message
seq
the sequence of values
allowDups
is allow duplicates

Annotations
@inline()
def requirePattern(value: String, pattern: Regex, name: String = NoNameParameter): Unit

Tests that value matches regular expression pattern, and otherwise throws IllegalArgumentException.
Tests that value matches regular expression pattern, and otherwise throws IllegalArgumentException.
value
the value to test
pattern
the pattern to test
name
the name to include in the failure message

Annotations
@inline()
def requirePositive[T](value: T, name: String = NoNameParameter)(implicit arg0: Numeric[T]): Unit

Tests that value is positive, and otherwise throws IllegalArgumentException.
Tests that value is positive, and otherwise throws IllegalArgumentException.
value
the value to test
name
the name to include in the failure message

Annotations
@inline()
def requireShort(value: String, name: String = NoNameParameter): Unit

Tests that value is a Short number string, and otherwise throws IllegalArgumentException.
Tests that value is a Short number string, and otherwise throws IllegalArgumentException.
value
the value to test
name
the name to include in the failure message

Annotations
@inline()
def requireSize[T](value: Iterable[T], size: Int, name: String = NoNameParameter): Unit

Tests that size of iterable value equals expected size, and otherwise throws IllegalArgumentException.
Tests that size of iterable value equals expected size, and otherwise throws IllegalArgumentException.
T
the type of iterable elements
value
the iterable value
size
the expected size
name
the name to include in the failure message

Annotations
@inline()
def requireSizeFrom[T](value: Iterable[T], from: Int, name: String = NoNameParameter): Unit

Tests that size of iterable value is from from inclusive until Int.MaxValue, and otherwise throws IllegalArgumentException.
Tests that size of iterable value is from from inclusive until Int.MaxValue, and otherwise throws IllegalArgumentException.
T
the type of iterable elements
value
the iterable value
from
the minimum size value (inclusive)
name
the name to include in the failure message

Annotations
@inline()
def requireSizeInRange[T](value: Iterable[T], from: Int, until: Int, name: String = NoNameParameter): Unit

Tests that size of iterable value is from from inclusive until until exclusive, and otherwise throws IllegalArgumentException.
Tests that size of iterable value is from from inclusive until until exclusive, and otherwise throws IllegalArgumentException.
T
the type of iterable elements
value
the iterable value
from
the minimum size value (inclusive)
until
the maximum size value (exclusive)
name
the name to include in the failure message

Annotations
@inline()
def requireSizeUntil[T](value: Iterable[T], until: Int, name: String = NoNameParameter): Unit

Tests that size of iterable value is from 0 inclusive until until exclusive, and otherwise throws IllegalArgumentException.
Tests that size of iterable value is from 0 inclusive until until exclusive, and otherwise throws IllegalArgumentException.
T
the type of iterable elements
value
the iterable value
until
the maximum size value (exclusive)
name
the name to include in the failure message

Annotations
@inline()
def requireUuid(uuid: String, name: String = NoNameParameter): Unit

Tests that string uuid is a correct universally unique identifier (UUID).
Tests that string uuid is a correct universally unique identifier (UUID).
uuid
the testing uuid string
name
the name to include in the failure message

Annotations
@inline()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toRequireElementFunction[T](f: RequireFunction[T]): RequireElementFunction[T]

Translates RequireFunction (for example RequireUtils.requireNotBlank(value:String* or RequireUtils#requireNotNull) to RequireElementFunction to use with RequireUtils#requireAll method.
Translates RequireFunction (for example RequireUtils.requireNotBlank(value:String* or RequireUtils#requireNotNull) to RequireElementFunction to use with RequireUtils#requireAll method.
Default implementation concatenates name and index in string name(index).
T
the type of iterable elements
f
the function to translate
returns
the translated function

Annotations
@inline()
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( ... )

Related Doc: package precondition

object RequireUtils

Type Members

type RequireElementFunction[T] = (T, String, Int) ⇒ Unit

type RequireFunction[T] = (T, String) ⇒ Unit

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def fail(message: ⇒ Any): Unit

def failureMessage(message: ⇒ Any): String

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def optional[T](value: Option[T])(require: (T) ⇒ Unit): Unit

def postfix: String

def prefix: String

def require(requirement: Boolean, message: ⇒ Any): Unit

def requireAll[T](value: Iterable[T], name: String = NoNameParameter)(require: RequireElementFunction[T]): Unit

def requireAllNotBlank(value: Iterable[String], name: String = NoNameParameter): Unit

def requireAllNotNull[T <: AnyRef](value: Iterable[T], name: String = NoNameParameter): Unit

def requireAtLeastOneOf[T](value: Iterable[T], name: String = NoNameParameter)(seq: Iterable[T], allowDups: Boolean = false): Unit

def requireByte(value: String, name: String = NoNameParameter): Unit

def requireDouble(value: String, name: String = NoNameParameter): Unit

def requireEmail(email: String, name: String = NoNameParameter): Unit

def requireFloat(value: String, name: String = NoNameParameter): Unit

def requireInt(value: String, name: String = NoNameParameter): Unit

def requireLong(value: String, name: String = NoNameParameter): Unit

def requireNegative[T](value: T, name: String = NoNameParameter)(implicit arg0: Numeric[T]): Unit

def requireNonNegative[T](value: T, name: String = NoNameParameter)(implicit arg0: Numeric[T]): Unit

def requireNonPositive[T](value: T, name: String = NoNameParameter)(implicit arg0: Numeric[T]): Unit

def requireNotBlank[T](value: Iterable[T]): Unit

def requireNotBlank[T](value: Iterable[T], name: String): Unit

def requireNotBlank(value: String, name: String = NoNameParameter): Unit

def requireNotNull(value: AnyRef, name: String = NoNameParameter): Unit

def requireNumber[T](value: T, name: String = NoNameParameter)(number: T)(implicit arg0: Numeric[T]): Unit

def requireNumberFrom[T](value: T, name: String = NoNameParameter)(leftBound: T, leftBoundType: BoundType = Inclusive)(implicit arg0: Numeric[T]): Unit

def requireNumberFromExclusive[T](value: T, name: String = NoNameParameter)(leftBound: T)(implicit arg0: Numeric[T]): Unit

def requireNumberInRange[T](value: T, name: String = NoNameParameter)(leftBound: T, leftBoundType: BoundType = Inclusive)(rightBound: T, rightBoundType: BoundType = Exclusive)(implicit arg0: Numeric[T]): Unit

def requireNumberInterval[T](value: T, name: String = NoNameParameter)(leftBound: T, rightBound: T)(implicit arg0: Numeric[T]): Unit

def requireNumberSegment[T](value: T, name: String = NoNameParameter)(leftBound: T, rightBound: T)(implicit arg0: Numeric[T]): Unit

def requireNumberUntil[T](value: T, name: String = NoNameParameter)(rightBound: T, rightBoundType: BoundType = Exclusive)(implicit arg0: Numeric[T]): Unit

def requireOnlyOneOf[T](value: Iterable[T], name: String = NoNameParameter)(seq: Iterable[T], allowDups: Boolean = false): Unit

def requirePattern(value: String, pattern: Regex, name: String = NoNameParameter): Unit

def requirePositive[T](value: T, name: String = NoNameParameter)(implicit arg0: Numeric[T]): Unit

def requireShort(value: String, name: String = NoNameParameter): Unit

def requireSize[T](value: Iterable[T], size: Int, name: String = NoNameParameter): Unit

def requireSizeFrom[T](value: Iterable[T], from: Int, name: String = NoNameParameter): Unit

def requireSizeInRange[T](value: Iterable[T], from: Int, until: Int, name: String = NoNameParameter): Unit

def requireSizeUntil[T](value: Iterable[T], until: Int, name: String = NoNameParameter): Unit

def requireUuid(uuid: String, name: String = NoNameParameter): Unit

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

def toRequireElementFunction[T](f: RequireFunction[T]): RequireElementFunction[T]

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped