Scalactic 3.3.0-SNAP4/org.scalactic/Requirements

Requirements

object Requirements extends Requirements

Companion object that facilitates the importing of Requirements members as an alternative to mixing it in. One use case is to import Requirements members so you can use them in the Scala interpreter:

$scala -classpath scalatest.jar
Welcome to Scala 2.13.6 (OpenJDK 64-Bit Server VM, Java yyy).
Type in expressions for evaluation. Or try :help.
 
scala> import org.scalactic.Requirements._
import org.scalactic.Requirements._
 
scala> val a = 1
a: Int = 1
 
scala> require(a == 2)
java.lang.IllegalArgumentException: 1 did not equal 2
    at org.scalactic.Requirements$RequirementsHelper.macroRequire(Requirements.scala:56)
    at .<init>(<console>:20)
    at .<clinit>(<console>)
    at .<init>(<console>:7)
    at .<clinit>(<console>)
    at $print(<console>)
    at sun.reflect.NativeMethodAccessorImpl.invoke...

Companion:: class
Source:: Requirements.scala

trait Requirements

class Object

trait Matchable

class Any

Requirements.type

Type members

Classlikes

Helper class used by code generated by the require macro.

Source:: Requirements.scala

Value members

Inherited methods

Require that a boolean condition about an argument passed to a method, function, or constructor, and described in the given clue, is true.

If the condition is true, this method returns normally. Else, it throws IllegalArgumentException with the String obtained by invoking toString on the specified clue and appending that to the macro-generated error message as the exception's detail message.

Value parameters:

clue: an objects whose toString method returns a message to include in a failure report.
condition: the boolean condition to check as requirement

Throws:

IllegalArgumentException: if the condition is false.
NullPointerException: if message is null.

Inherited from:

Requirements

Source:

Requirements.scala

Require that a boolean condition is true about an argument passed to a method, function, or constructor.

If the condition is true, this method returns normally. Else, it throws IllegalArgumentException.

This method is implemented in terms of a Scala macro that will generate an error message. See the main documentation for this trait for examples.

Value parameters:

condition: the boolean condition to check as requirement

Throws:

IllegalArgumentException: if the condition is false.

Inherited from:

Requirements

Source:

Requirements.scala

Require that all passed arguments are non-null.

If none of the passed arguments are null, this method returns normally. Else, it throws NullArgumentException with an error message that includes the name (as it appeared in the source) of each argument that was null.

Value parameters:

arguments: arguments to check for null value

Throws:

NullArgumentException: if any of the arguments are null.

Inherited from:

Requirements

Source:

Requirements.scala

Require that a boolean condition about the state of an object on which a method has been invoked, and described in the given clue, is true.

If the condition is true, this method returns normally. Else, it throws IllegalStateException with the String obtained by invoking toString on the specified clue appended to the macro-generated error message as the exception's detail message.

Value parameters:

clue: an object whose toString method returns a message to include in a failure report.
condition: the boolean condition to check as a requirement

Throws: