specs2-common
API
Generated with
specs2-common/org.specs2/org.specs2.control

org.specs2.control

package org.specs2.control

Members list

Packages

package org.specs2.control.eff
package org.specs2.control.origami
package org.specs2.control.producer

Type members

Classlikes

case class ActionException(warnings: List[String], message: Option[String], throwable: Option[Throwable]) extends Exception

This exception class is used when an Action is transformed to a Task to avoid losing information

This exception class is used when an Action is transformed to a Task to avoid losing information

Attributes

Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object Actions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Actions.type
trait Debug extends ImplicitParameters

This trait provides simple a way to print out any object to the console:

This trait provides simple a way to print out any object to the console:

"this string".pp must_== "this string"

will print 'this string' and pass it to the rest of the expectation

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Debug.type
trait NoDebug
object Debug extends Debug

Attributes

Companion
trait
Supertypes
trait Debug
class Object
trait Matchable
class Any
Self type
Debug.type
object DefaultStackTraceFilter extends IncludeExcludeStackTraceFilter, ExecutionOrigin

default filter for specs2 runs

default filter for specs2 runs

Attributes

Supertypes
trait Stacktraces
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
trait Exceptions

This trait provides methods to catch exceptions and transform them into values which can be passed to further computations.

This trait provides methods to catch exceptions and transform them into values which can be passed to further computations.

It uses the facilities found in the scala.util.control.Exception object while providing a more concise api on some use cases.

Attributes

See also

org.specs2.control.ExceptionsSpec for examples

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Exceptions.type
object Exceptions extends Exceptions

Attributes

Companion
trait
Supertypes
trait Exceptions
class Object
trait Matchable
class Any
Self type
Exceptions.type
object Executable

Execute external commands

Execute external commands

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Executable.type
trait ExecutionOrigin extends Stacktraces

This trait is used primarily to change the junit behavior depending on the execution environment

This trait is used primarily to change the junit behavior depending on the execution environment

Attributes

Companion
object
Supertypes
trait Stacktraces
class Object
trait Matchable
class Any
Known subtypes
object ExecutionOrigin.type
object ExecutionOrigin extends ExecutionOrigin

Attributes

Companion
trait
Supertypes
trait Stacktraces
class Object
trait Matchable
class Any
Self type
trait Functions

This trait provides utility methods for functions

This trait provides utility methods for functions

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Functions.type
object Functions extends Functions

Attributes

Companion
trait
Supertypes
trait Functions
class Object
trait Matchable
class Any
Self type
Functions.type
object FutureInstances

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
trait HasStackTrace

This trait describes something which has a stackTrace with:

This trait describes something which has a stackTrace with:

  • a list of stacktrace element

This is used to provide a common interface to execute.Failure and execute.Error

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Error
class Failure
trait ImplicitParameters

This trait is used to abuse method overloading and allow some of the methods in specs2 DSL to be applicable to various parameters.

This trait is used to abuse method overloading and allow some of the methods in specs2 DSL to be applicable to various parameters.

For example in a mutable specification, the >> method is overloaded for lots of different arguments:

  • result
  • function of the Environment
  • function of the Command line
  • ...

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Debug
object Debug.type
trait NoDebug
object ImplicitParameters.type
object ImplicitParameters extends ImplicitParameters

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class IncludeExcludeStackTraceFilter(include: Seq[String], exclude: Seq[String]) extends StackTraceFilter

Implementation of the StackTraceFilter trait with a list of include/exclude patterns

Implementation of the StackTraceFilter trait with a list of include/exclude patterns

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
Self type
object IncludeExcludeStackTraceFilter

Factory object to build a stack trace filter from include/exclude expressions:

Factory object to build a stack trace filter from include/exclude expressions:

.*specs2 ==> include .*specs2 traces .specs2/scala. ==> include .specs2 traces, exclude scala. traces .*specs2,scala/scalaz,eclipse ==> include .*specs2,scala traces, exclude scalaz and eclipse traces

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
class LazyParameter[+T](v: () => T)

class holding a value to be evaluated lazily

class holding a value to be evaluated lazily

Attributes

Supertypes
class Object
trait Matchable
class Any
trait LazyParameters

This trait can be used to allow some function to be called with varargs, with values being evaluated lazily:

This trait can be used to allow some function to be called with varargs, with values being evaluated lazily:

 def method[T](values: LazyParameter[T]*) = {
   values.toStream // use the toStream method to consume the values lazily
 }
 // usage
 method(exp1, exp2, exp3)

Note that the values are really evaluated once, unlike a by-name parameter.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object LazyParameters.type
object LazyParameters extends LazyParameters

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class LazyValue[T](t: () => T)

This class simply encapsulates a lazy value which will be only evaluated once

This class simply encapsulates a lazy value which will be only evaluated once

Attributes

See also

org.specs2.specification.process.RandomSequentialExecution for an example of use

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class NamedThreadFactory(namePrefix: String, group: ThreadGroup, priority: Int) extends ThreadFactory

This factory creates named threads which can be prefixed by "specs2" to track the threads used by specs2 for the specification execution

This factory creates named threads which can be prefixed by "specs2" to track the threads used by specs2 for the specification execution

Contributed by @jedws

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ThreadFactory
class Object
trait Matchable
class Any
Show all
trait NoDebug extends Debug

Use this trait to disable the pp method on objects

Use this trait to disable the pp method on objects

Attributes

Supertypes
trait Debug
class Object
trait Matchable
class Any
trait NoNumberOfTimes extends NumberOfTimes

Attributes

Supertypes
class Object
trait Matchable
class Any
object NoStackTraceFilter extends StackTraceFilter

This filter doesn't do anything

This filter doesn't do anything

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
trait NumberOfTimes

Syntactic sugar to execute an action a given number of times

Syntactic sugar to execute an action a given number of times

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object NumberOfTimes.type
object NumberOfTimes extends NumberOfTimes

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object Operations

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Operations.type
trait Properties

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Properties.type
object Properties extends Properties

Attributes

Companion
trait
Supertypes
trait Properties
class Object
trait Matchable
class Any
Self type
Properties.type
case class Property[T](value: () => Option[T], evaluated: Boolean, evaluatedValue: Option[T])

This class represents values which are evaluated lazily and which may even be missing.

This class represents values which are evaluated lazily and which may even be missing.

It has Option-like function and can be also converted to an Either object

Attributes

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

Companion object to create properties with possibly no initial value

Companion object to create properties with possibly no initial value

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Property.type
trait StackTraceFilter

This trait filters an Exception stacktrace

This trait filters an Exception stacktrace

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object NoStackTraceFilter.type
object StackTraceFilter

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait Stacktraces

Utility methods to determine the origin of the execution of the current code

Utility methods to determine the origin of the execution of the current code

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ExecutionOrigin.type
object Stacktraces.type
object Stacktraces extends Stacktraces

Attributes

Companion
trait
Supertypes
trait Stacktraces
class Object
trait Matchable
class Any
Self type
object Throwables

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Throwables.type
trait Throwablex

This trait adds some utility methods to Throwable objects.

This trait adds some utility methods to Throwable objects.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Throwablex.type
object Throwablex extends Throwablex

Attributes

Companion
trait
Supertypes
trait Throwablex
class Object
trait Matchable
class Any
Self type
Throwablex.type
case class Times(n: Int)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TraceLocation(path: String, fileName: String, className: String, methodName: String, lineNumber: Int)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object Use

Utility object to show a parameter as used In particular this is useful to avoid warnings with ImplicitParameters

Utility object to show a parameter as used In particular this is useful to avoid warnings with ImplicitParameters

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Use.type
case class UserException(message: String, throwable: Throwable) extends Exception

This exception class is used to notify the user of instantiation errors

This exception class is used to notify the user of instantiation errors

Attributes

Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
implicit class actionOps[T](action: Action[T])

Attributes

Supertypes
class Object
trait Matchable
class Any
implicit class ioOperationToOption[T](operation: Operation[T])

Attributes

Supertypes
class Object
trait Matchable
class Any
implicit class operationOps[T](operation: Operation[T])

Attributes

Supertypes
class Object
trait Matchable
class Any

Types

type Action[A] = Eff[ActionStack, A]
type AsyncFold[A, B] = Fold[Action, A, B]
type AsyncSink[A] = Fold[Action, A, Unit]
type AsyncTransducer[A, B] = (ActionStack, A) => B
type Logger = String => Unit

Actions logging

Actions logging

Attributes

type Operation[A] = Eff[OperationStack, A]

Value members

Concrete methods

def attemptExecuteOperation[A](operation: Operation[A], printer: String => Unit): Either[Throwable, (Either[Error, A], List[String])]
def emitAsync[A](as: A*): AsyncStream[A]
def emitAsyncDelayed[A](a: A): AsyncStream[A]
def executeOperation[A](operation: Operation[A], printer: String => Unit): (Either[Error, A], List[String])
def runOperation[A](operation: Operation[A], printer: String => Unit): Either[Error, A]
def warnAndFail[R, A](message: String, failureMessage: String)(implicit m1: Member[Warnings, R], m2: Member[ErrorOrOk, R]): Eff[R, A]

warn the user about something that is probably wrong on his side, this is not a specs2 bug, then fail to stop all further computations

warn the user about something that is probably wrong on his side, this is not a specs2 bug, then fail to stop all further computations

Attributes

Concrete fields

lazy val consoleLogging: String => Unit
lazy val noLogging: String => Unit

Implicits

Implicits

final implicit def actionOps[T](action: Action[T]): actionOps[T]
implicit val idToAction: NaturalTransformation[Id, Action]
final implicit def ioOperationToOption[T](operation: Operation[T]): ioOperationToOption[T]
implicit def operationAsResult[T : AsResult]: AsResult[Operation[T]]

This implicit allows an Operation[result] to be used inside an example.

This implicit allows an Operation[result] to be used inside an example.

Attributes

final implicit def operationOps[T](operation: Operation[T]): operationOps[T]
implicit def operationToAction[A](operation: Operation[A]): Action[A]
implicit def operationToActionNat[A]: NaturalTransformation[Operation, Action]
Generated with