Class

org.specs2.execute

SnippetParams

Related Doc: package execute

Permalink

case class SnippetParams[T](trimExpression: (String) ⇒ String = trimApproximatedSnippet, cutter: (String) ⇒ String = ScissorsCutter(), asCode: (String, String) ⇒ String = markdownCode(offset = 0), prompt: (String) ⇒ String = greaterThanPrompt, evalCode: Boolean = false, verify: Option[(T) ⇒ Result] = None) extends Product with Serializable

Evaluation and display parameters for a Snippet.

It is possible to change:

the function that's trimming the expression from newlines or accolades
the cutter function to remove part which must not be shown
the asCode function to render the resulting text
the prompt function to possibly display the evaluated result with a prompt
the eval boolean indicating if a snippet must be evaluated
the verify function checking the result

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

SnippetParams
Serializable
Serializable
Product
Equals
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new SnippetParams(trimExpression: (String) ⇒ String = trimApproximatedSnippet, cutter: (String) ⇒ String = ScissorsCutter(), asCode: (String, String) ⇒ String = markdownCode(offset = 0), prompt: (String) ⇒ String = greaterThanPrompt, evalCode: Boolean = false, verify: Option[(T) ⇒ Result] = None)

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
val asCode: (String, String) ⇒ String
final def asInstanceOf[T0]: T0

Definition Classes
Any
def check[R](f: (T) ⇒ R)(implicit arg0: AsResult[R]): SnippetParams[T]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
val cutter: (String) ⇒ String
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def eval: SnippetParams[T]
val evalCode: Boolean
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def offsetIs(offset: Int): SnippetParams[T]
val prompt: (String) ⇒ String
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val trimExpression: (String) ⇒ String
val verify: Option[(T) ⇒ Result]
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped