specs2-core
API
Generated with
specs2-core/org.specs2/org.specs2.specification/org.specs2.specification.core/Execution

Execution

org.specs2.specification.core.Execution
See theExecution companion object
case class Execution(run: Option[Env => Future[() => Result]], executing: Executing, timeout: Option[FiniteDuration], mustJoin: Boolean, nextMustStopIf: Result => Boolean, previousResult: Option[Result], finalResultMap: Option[Result => Result], continuation: Option[FragmentsContinuation])

Execution of a Fragment

  • there can be none (for a piece of text)
  • the execution depends on the current Env. by default executions are created synchronously but can also be fork-off with Execution.withEnvAsync
  • it can have its own timeout (default is infinite)
  • once executed the result is kept
  • if mustJoin is true this means that all previous executions must be finished before this one can start
  • it has a condition deciding if the next execution can proceed or not depending on the current result
  • the result of a similar execution can be stored to decide if this one needs to be executed or not
  • it can store a continuation that will create more fragments, possibly containing more executions, based on the current result

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def after(executions: List[Execution]): Execution

run this execution after the previous executions are finished

run this execution after the previous executions are finished

Attributes

def afterSequential(executions: List[Execution]): Execution

run this execution after the other executions have been sequentially executed

run this execution after the other executions have been sequentially executed

Attributes

def afterSuccessful(executions: List[Execution]): Execution

run this execution after the executions and only if they are successful

run this execution after the executions and only if they are successful

Attributes

def afterSuccessfulSequential(executions: List[Execution]): Execution

run this execution after the other executions have been sequentially executed and only if they are successful

run this execution after the other executions have been sequentially executed and only if they are successful

Attributes

override def equals(a: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Equals -> Any
override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
def isExecutable: Boolean

Attributes

Returns

true if something can be run

def mapFinalResult(f: Result => Result): Execution

modify the final result - the passed function cannot throw an exception!

modify the final result - the passed function cannot throw an exception!

Attributes

def mapResult(f: Result => Result): Execution

map a result - the passed function can potentially throw an exception

map a result - the passed function can potentially throw an exception

Attributes

def setContinuation(fs: => Fragments): Execution

methods to set the execution

methods to set the execution

Attributes

def setExecuting(r: Future[(Result, SimpleTimer)]): Execution

Attributes

Returns

set an execution result being computed

def setFatal(f: Throwable): Execution

Attributes

Returns

set a fatal execution error

def setPreviousResult(r: Option[Result]): Execution
def setResult(r: => Result): Execution

Attributes

Returns

set an execution result

def setTimeout(timeout: FiniteDuration): Execution
def startAfter(other: Execution)(env: Env): Execution

start this execution when the other one is finished

start this execution when the other one is finished

Attributes

def startAfter(others: List[Execution])(env: Env): Execution

start this execution when the other ones are finished

start this execution when the other ones are finished

Attributes

def startExecution(env: Env): Execution

run the execution

run the execution

Attributes

def stopNextIf(r: Result): Execution
def stopNextIf(f: Result => Boolean): Execution
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
def updateMessage(f: String => String): Execution

force a message

force a message

Attributes

def updateResult(newResult: (=> Result) => Result): Execution
def updateRun(newRun: (Env => Future[() => Result]) => Env => Future[() => Result]): Execution
def was(statusCheck: String => Boolean): Boolean

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Concrete fields

lazy val executedResult: Action[ExecutedResult]
lazy val executionResult: Action[Result]
Generated with