Require

Instance Constructors

new Require()

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 exception(message: String, cause: Option[RuntimeException] = None): RuntimeException

Creates a new instance of exception.
Creates a new instance of exception. Default implementation uses RequireCore.DefaultExceptionCreator exception creator.
message
the message (must be non-blank)
cause
the cause exception (must be non-null and not Some(null))
returns
new exception instance (non-null)

Definition Classes
RequireCore
Exceptions thrown
RuntimeException if any argument is not valid
def fail(message: ⇒ Any, throwable: Option[RuntimeException] = None): Unit

Fails test.
Fails test. Must be invoked at every time when requireXXX method fails. Default implementation invokes exception() to create new exception instance with message produced by failureMessage() method and throws the result.
message
the String to include in the failure message (must be non-null)

Definition Classes
RequireCore
Exceptions thrown
RuntimeException at every invokation
def failureMessage[T](message: ⇒ T): String

Constructs the failure message.
Constructs the failure message. Default implementation invokes toString() method of message and returns result.
message
the source message (must be non-null)
returns
the failure message (non-null)

Definition Classes
RequireCore
Exceptions thrown
RuntimeException if message is null
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], name: String = NoNameParameter)(require: RequireFunction[T]): 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 (must be non-null)
require
the function (must be non-null)

Definition Classes
RequireOptional
Annotations
@inline()
def optionalPredicate[T](value: Option[T], name: String = NoNameParameter)(predicate: RequirePredicate[T]): Unit

Definition Classes
RequireOptional
Annotations
@inline()
implicit def pred2elem[T](predicate: RequirePredicate[T]): RequireElementFunction[T]

Wraps predicate RequirePredicate to element function RequireElementFunction.
Wraps predicate RequirePredicate to element function RequireElementFunction.
T
the type of element
predicate
the predicate (must be non-null)
returns
the new RequireElementFunction instance

Definition Classes
RequireCore
implicit def pred2func[T](predicate: RequirePredicate[T]): RequireFunction[T]

Wraps predicate RequirePredicate to element function RequireFunction.
Wraps predicate RequirePredicate to element function RequireFunction.
T
the type of element
predicate
the predicate (must be non-null)
returns
the new RequireFunction instance

Definition Classes
RequireCore
def require[T](requirement: ⇒ Boolean, message: ⇒ T): Unit

Invokes requirement to test an expression and calls fail if it returns false.
Invokes requirement to test an expression and calls fail if it returns false.
requirement
the expression to test
message
a String to include in the failure message (must be non-null)

Definition Classes
RequireCore
Exceptions thrown
RuntimeException if requirement invokation returns false of any argument is not valid
def requireAll[T](value: Iterable[T], name: String = NoNameParameter)(require: RequireElementFunction[T]): Unit

Calls require for all elements of iterable value.
Calls require for all elements of iterable value. The require must test the element and throws RequireCore.exception() if it's not satisfy the requirements.
T
the type of iterable elements
value
the iterable value (must be non-null)
name
the name to include in the failure message (must be non-null)
require
the test function (must be non-null)

Definition Classes
RequireAll
Exceptions thrown
RuntimeException if test fails
def requireAllNotBlank(value: Iterable[String], name: String = NoNameParameter): Unit

Tests that iterable value does not contain blank (null or empty) strings, and otherwise throws RequireCore.exception().
Tests that iterable value does not contain blank (null or empty) strings, and otherwise throws RequireCore.exception().
value
the iterable value (must be non-null)
name
the name to include in the failure message (must be non-null)

Definition Classes
RequireAllSpecific
Annotations
@inline()
def requireAllNotNull[T](value: Iterable[T], name: String = NoNameParameter): Unit

Tests that iterable value does not contain null values, and otherwise throws RequireCore.exception().
Tests that iterable value does not contain null values, and otherwise throws RequireCore.exception().
T
the type of iterable elements
value
the iterable value (must be non-null)
name
the name to include in the failure message (must be non-null)

Definition Classes
RequireAllSpecific
Annotations
@inline()
def requireAllPredicate[T](value: Iterable[T], name: String = NoNameParameter)(predicate: RequirePredicate[T]): Unit

Calls predicate for all elements of iterable value.
Calls predicate for all elements of iterable value. It throws RequireCore.exception() if there's an element that does not satisfy the requirements.
T
the type of iterable elements
value
the iterable value (must be non-null)
name
the name to include in the failure message (must be non-null)
predicate
the predicate (must be non-null)

Definition Classes
RequireAll
Exceptions thrown
RuntimeException if test fails
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

Definition Classes
RequireStringNumeric
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

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

Tests that string email is a correct email address, and otherwise throws RequireCore.exception().
Tests that string email is a correct email address, and otherwise throws RequireCore.exception().
email
the testing email string (must be non-null)
name
the name to include in the failure message (must be non-null)

Definition Classes
RequireStringFormat
Annotations
@inline()
Exceptions thrown
RuntimeException if test fails
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

Definition Classes
RequireStringNumeric
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

Definition Classes
RequireStringNumeric
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

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

Tests that value is negative, and otherwise throws RequireCore.exception().
Tests that value is negative, and otherwise throws RequireCore.exception().
value
the value to test (must be non-null)
name
the name to include in the failure message (must be non-null)

Definition Classes
RequireNumeric
Exceptions thrown
RuntimeException if test fails
def requireNonNegative[T](value: T, name: String = NoNameParameter)(implicit arg0: Numeric[T]): Unit

Tests that value is positive or zero, and otherwise throws RequireCore.exception().
Tests that value is positive or zero, and otherwise throws RequireCore.exception().
value
the value to test (must be non-null)
name
the name to include in the failure message (must be non-null)

Definition Classes
RequireNumeric
Exceptions thrown
RuntimeException if test fails
def requireNonPositive[T](value: T, name: String = NoNameParameter)(implicit arg0: Numeric[T]): Unit

Tests that value is negative or zero, and otherwise throws RequireCore.exception().
Tests that value is negative or zero, and otherwise throws RequireCore.exception().
value
the value to test (must be non-null)
name
the name to include in the failure message (must be non-null)

Definition Classes
RequireNumeric
Exceptions thrown
RuntimeException if test fails
def requireNotBlank[T](value: Iterable[T]): Unit

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

Definition Classes
RequireIterable
Exceptions thrown
RuntimeException if test fails
def requireNotBlank[T](value: Iterable[T], name: String): Unit

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

Definition Classes
RequireIterable
Exceptions thrown
RuntimeException if test fails
def requireNotBlank(value: String, name: String = NoNameParameter): Unit

Tests that value isn't null or empty (after trim), and otherwise throws RequireCore.exception().
Tests that value isn't null or empty (after trim), and otherwise throws RequireCore.exception().
value
the value to test (must be non-null)
name
the name to include in the failure message (must be non-null)

Definition Classes
RequireString
Exceptions thrown
RuntimeException if test fails
def requireNotNull(value: Any, name: String = NoNameParameter): Unit

Tests that value isn't null, and otherwise throws RequireCore.exception().
Tests that value isn't null, and otherwise throws RequireCore.exception().
value
the value to test
name
the name to include in the failure message (must be non-null)

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

Test that value is equal to number, and otherwise throws RequireCore.exception().
Test that value is equal to number, and otherwise throws RequireCore.exception().
T
the type of iterable elements
value
the value (must be non-null)
number
the required number (must be non-null)
name
the name to include in the failure message (must be non-null)

Definition Classes
RequireNumericRange
Annotations
@inline()
Exceptions thrown
RuntimeException if test fails
def requireNumberFrom[T](value: T, leftBound: BoundedNumber[T], name: String = NoNameParameter)(implicit arg0: Numeric[T]): Unit

Tests that value is from leftBound until maximum value of type T (inclusive), and otherwise throws RequireCore.exception().
Tests that value is from leftBound until maximum value of type T (inclusive), and otherwise throws RequireCore.exception().
T
the type of value
value
the value (must be non-null)
leftBound
the left bound (must be non-null)
name
the name to include in the failure message (must be non-null)

Definition Classes
RequireNumericRange
Annotations
@inline()
Exceptions thrown
RuntimeException if test fails
def requireNumberInRange[T](value: T, leftBound: BoundedNumber[T], rightBound: BoundedNumber[T], name: String = NoNameParameter)(implicit arg0: Numeric[T]): Unit

Tests that value is from leftBound until rightBound, and otherwise throws RequireCore.exception().
Tests that value is from leftBound until rightBound, and otherwise throws RequireCore.exception().
T
the type of value
value
the value (must be non-null)
leftBound
the left bound (must be non-null)
rightBound
the right bound (must be non-null)

Definition Classes
RequireNumericRange
Annotations
@inline()
Exceptions thrown
RuntimeException if test fails
def requireNumberUntil[T](value: T, rightBound: BoundedNumber[T], name: String = NoNameParameter)(implicit arg0: Numeric[T]): Unit

Tests that value is from minimum value of type T (inclusive) until rightBound, and otherwise throws RequireCore.exception().
Tests that value is from minimum value of type T (inclusive) until rightBound, and otherwise throws RequireCore.exception().
T
the type of value
value
the value (must be non-null)
rightBound
the right bound (must be non-null)
name
the name to include in the failure message (must be non-null)

Definition Classes
RequireNumericRange
Annotations
@inline()
Exceptions thrown
RuntimeException if test fails
def requirePattern(value: String, pattern: Regex, name: String = NoNameParameter): Unit

Tests that value matches regular expression pattern, and otherwise throws RequireCore.exception().
Tests that value matches regular expression pattern, and otherwise throws RequireCore.exception().
value
the value to test (must be non-null)
pattern
the pattern to test (must be non-null)
name
the name to include in the failure message (must be non-null)

Definition Classes
RequireString
Exceptions thrown
RuntimeException if test fails
def requirePositive[T](value: T, name: String = NoNameParameter)(implicit arg0: Numeric[T]): Unit

Tests that value is positive, and otherwise throws RequireCore.exception().
Tests that value is positive, and otherwise throws RequireCore.exception().
value
the value to test (must be non-null)
name
the name to include in the failure message (must be non-null)

Definition Classes
RequireNumeric
Exceptions thrown
RuntimeException if test fails
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

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

Tests that size of iterable value equals size, and otherwise throws RequireCore.exception().
Tests that size of iterable value equals size, and otherwise throws RequireCore.exception().
T
the type of iterable elements
value
the iterable value (must be non-null)
size
the expected size (must be positive)
name
the name to include in the failure message (must be non-null)

Definition Classes
RequireSize
Annotations
@inline()
Exceptions thrown
RuntimeException if test fails
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 inclusive, and otherwise throws RequireCore.exception().
Tests that size of iterable value is from from inclusive until Int.MaxValue inclusive, and otherwise throws RequireCore.exception().
T
the type of iterable elements
value
the iterable value (must be non-null)
from
the minimum size value (inclusive)
name
the name to include in the failure message (must be non-null)

Definition Classes
RequireSize
Annotations
@inline()
Exceptions thrown
RuntimeException if test fails
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 RequireCore.exception().
Tests that size of iterable value is from from inclusive until until exclusive, and otherwise throws RequireCore.exception().
T
the type of iterable elements
value
the iterable value (must be non-null)
from
the minimum size value (inclusive)
until
the maximum size value (exclusive)
name
the name to include in the failure message (must be non-null)

Definition Classes
RequireSize
Annotations
@inline()
Exceptions thrown
RuntimeException if test fails
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 RequireCore.exception().
Tests that size of iterable value is from 0 inclusive until until exclusive, and otherwise throws RequireCore.exception().
T
the type of iterable elements
value
the iterable value (must be non-null)
until
the maximum size value (exclusive)
name
the name to include in the failure message (must be non-null)

Definition Classes
RequireSize
Annotations
@inline()
Exceptions thrown
RuntimeException if test fails
def requireUniqueField[T, F](value: Iterable[T], name: String = NoNameParameter, field: String = NoNameParameter)(extractor: FieldExtractor[T, F]): Unit

Test that all elements of iterable value has unique value of field extracted by extractor.
Test that all elements of iterable value has unique value of field extracted by extractor.
T
the iterable element type
F
the testing field type
value
the testing iterable (must be non-null)
name
the name to include in the failure message (must be non-blank)
field
the field name to include in the failure message (must be non-blank)
extractor
the extractor function to extract field value from instance of T (must be non-null)

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

Tests that string uuid is a correct universally unique identifier (UUID), and otherwise throws RequireCore.exception().
Tests that string uuid is a correct universally unique identifier (UUID), and otherwise throws RequireCore.exception().
uuid
the testing uuid string (must be non-null)
name
the name to include in the failure message (must be non-null)

Definition Classes
RequireStringFormat
Annotations
@inline()
Exceptions thrown
RuntimeException if test fails
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( ... )

Related Docs: object Require | package require

class Require extends RequireCore with RequireAll with RequireAllSpecific with RequireAny with RequireIterable with RequireUnique with RequireNumeric with RequireNumericRange with RequireOptional with RequireSize with RequireString with RequireStringFormat with RequireStringNumeric

Instance Constructors

new Require()

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 exception(message: String, cause: Option[RuntimeException] = None): RuntimeException

def fail(message: ⇒ Any, throwable: Option[RuntimeException] = None): Unit

def failureMessage[T](message: ⇒ T): 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], name: String = NoNameParameter)(require: RequireFunction[T]): Unit

def optionalPredicate[T](value: Option[T], name: String = NoNameParameter)(predicate: RequirePredicate[T]): Unit

implicit def pred2elem[T](predicate: RequirePredicate[T]): RequireElementFunction[T]

implicit def pred2func[T](predicate: RequirePredicate[T]): RequireFunction[T]

def require[T](requirement: ⇒ Boolean, message: ⇒ T): 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](value: Iterable[T], name: String = NoNameParameter): Unit

def requireAllPredicate[T](value: Iterable[T], name: String = NoNameParameter)(predicate: RequirePredicate[T]): 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: Any, name: String = NoNameParameter): Unit

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

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

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

def requireNumberUntil[T](value: T, rightBound: BoundedNumber[T], name: String = NoNameParameter)(implicit arg0: Numeric[T]): 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 requireUniqueField[T, F](value: Iterable[T], name: String = NoNameParameter, field: String = NoNameParameter)(extractor: FieldExtractor[T, F]): Unit

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

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from RequireStringNumeric

Inherited from RequireStringFormat

Inherited from RequireSize

Inherited from RequireOptional

Inherited from RequireNumericRange

Inherited from RequireNumeric

Inherited from RequireUnique

Inherited from RequireIterable

Inherited from RequireAllSpecific

Inherited from RequireString

Inherited from RequireAny

Inherited from RequireAll

Inherited from RequireCore

Inherited from AnyRef

Inherited from Any

Ungrouped