c

org.specs2.execute

SnippetParams

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, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SnippetParams
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val asCode: (String, String) => String
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def check[R](f: (T) => R)(implicit arg0: AsResult[R]): SnippetParams[T]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. val cutter: (String) => String
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def eval: SnippetParams[T]
  11. val evalCode: Boolean
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def offsetIs(offset: Int): SnippetParams[T]
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. val prompt: (String) => String
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. val trimExpression: (String) => String
  23. val verify: Option[(T) => Result]
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped