org.specs2.form

Effect

Related Docs: object Effect | package form

case class Effect[T](label: String, value: Property[T], decorator: Decorator = Decorator()) extends Executable with StandardResults with DecoratedProperty[Effect[T]] with Product with Serializable

An Effect is a property which is used to display names corresponding to side-effects.

If the side effect throws an exception, the Effect will display it alongside to the label. Otherwise only the label is displayed.

The apply method can be used to execute the Effect effect and possibly get a value out of it (but usually not displayed): Effect(label, 1).apply() must_== 1

The value is stored in a Property object so it will not be evaluated until explicitly queried.

Linear Supertypes
Serializable, Serializable, Product, Equals, DecoratedProperty[Effect[T]], DecoratedLabel[Effect[T]], StandardResults, Executable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Effect
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. DecoratedProperty
  7. DecoratedLabel
  8. StandardResults
  9. Executable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Effect(label: String, value: Property[T], decorator: Decorator = Decorator())

Type Members

  1. implicit class pendingResult extends AnyRef

    any block of code following a pending object will be pending

    any block of code following a pending object will be pending

    Definition Classes
    StandardResults

  2. implicit class skippedResult extends AnyRef

    any block of code following a skipped object will be skipped

    any block of code following a skipped object will be skipped

    Definition Classes
    StandardResults

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. def anError: Error

    Definition Classes
    StandardResults

  5. def apply(): T

    returns

    the effect value

  6. def apply(v: ⇒ T): Effect[T]

    set a new value on the effect.

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. def decorateLabel(ns: Any): Any

    do the decoration

    do the decoration

    Definition Classes
    DecoratedLabel

  10. def decorateLabelWith(f: (Any) ⇒ Any): Effect[T]

    set a new Decorator for the label

    set a new Decorator for the label

    Definition Classes
    DecoratedLabel

  11. def decorateValue(ns: Any): Any

    do the decoration

    do the decoration

    Definition Classes
    DecoratedProperty

  12. def decorateValueWith(f: (Any) ⇒ Any): Effect[T]

    set a new Decorator for the value

    set a new Decorator for the value

    Definition Classes
    DecoratedProperty

  13. def decorateWith(f: (Any) ⇒ Any): Effect[T]

    set a new Decorator

    set a new Decorator

    Definition Classes
    DecoratedProperty

  14. val decorator: Decorator

    Definition Classes
    Effect → DecoratedLabel

  15. def decoratorIs(d: Decorator): Effect[T]

    set a new Decorator

    set a new Decorator

    Definition Classes
    Effect → DecoratedLabel

  16. def done: Success

    Definition Classes
    StandardResults

  17. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  18. def equals(a: Any): Boolean

    Definition Classes
    Effect → Equals → AnyRef → Any

  19. def execute: Result

    executing an effect execute the value and returns success unless there is an Error

    executing an effect execute the value and returns success unless there is an Error

    returns

    a Result

    Definition Classes
    Effect → Executable

  20. def failure: Failure

    Definition Classes
    StandardResults

  21. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  22. def get: T

    alias for apply()

  23. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  24. def hashCode(): Int

    Definition Classes
    Effect → AnyRef → Any

  25. def header: Effect[T]

    use this Effect as a header in a table

  26. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  27. val label: String

  28. def labelStyles: String

    return the label styles

    return the label styles

    Definition Classes
    DecoratedLabel

  29. def map(f: (Result) ⇒ Result): Executable

    modify the result to return

    modify the result to return

    Definition Classes
    Executable

  30. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  31. final def notify(): Unit

    Definition Classes
    AnyRef

  32. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  33. def pending[R](r: ⇒ R)(implicit arg0: AsResult[R]): Pending

    Definition Classes
    StandardResults

  34. def pending: Pending

    Definition Classes
    StandardResults

  35. def pending(message: String): Pending

    Definition Classes
    StandardResults

  36. def skipped[R](r: ⇒ R)(implicit arg0: AsResult[R]): Skipped

    Definition Classes
    StandardResults

  37. def skipped: Skipped

    Definition Classes
    StandardResults

  38. def skipped(message: String): Skipped

    Definition Classes
    StandardResults

  39. def styleLabelWith(s: (String, String)): Effect[T]

    set a new style for the label

    set a new style for the label

    Definition Classes
    DecoratedLabel

  40. def styleValueWith(s: (String, String)): Effect[T]

    set a new style for the value

    set a new style for the value

    Definition Classes
    DecoratedProperty

  41. def styleWith(s: (String, String)): Effect[T]

    set a new style

    set a new style

    Definition Classes
    DecoratedProperty

  42. def success: Success

    Definition Classes
    StandardResults

  43. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  44. def toString(): String

    returns

    "label"

    Definition Classes
    Effect → AnyRef → Any

  45. def todo: Pending

    Definition Classes
    StandardResults

  46. val value: Property[T]

  47. def valueOrResult: Either[Result, T]

  48. def valueStyles: String

    Definition Classes
    DecoratedProperty

  49. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  50. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  51. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  52. def wontdo: Success

    Definition Classes
    StandardResults

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DecoratedProperty[Effect[T]]

Inherited from DecoratedLabel[Effect[T]]

Inherited from StandardResults

Inherited from Executable

Inherited from AnyRef

Inherited from Any

Ungrouped