org.specs2.form

Effect

case class Effect [T] (label: String, value: Property[T], 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. Hide All
  2. Show all
  1. Effect
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. DecoratedProperty
  7. DecoratedLabel
  8. StandardResults
  9. Executable
  10. AnyRef
  11. Any
Visibility
  1. Public
  2. All

Instance Constructors

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

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  6. def anError : Error

    Definition Classes
    StandardResults

  7. def apply (): T

    returns

    the effect value

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

    set a new value on the effect.

  9. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  10. def canEqual (arg0: Any): Boolean

    Definition Classes
    Effect → Equals

  11. def clone (): AnyRef

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

  12. def decorateLabel (ns: Any): Any

    do the decoration

    do the decoration

    Definition Classes
    DecoratedLabel

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

    set a new Decorator for the label

    set a new Decorator for the label

    Definition Classes
    DecoratedLabel

  14. def decorateValue (ns: Any): Any

    do the decoration

    do the decoration

    Definition Classes
    DecoratedProperty

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

    set a new Decorator for the value

    set a new Decorator for the value

    Definition Classes
    DecoratedProperty

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

    set a new Decorator

    set a new Decorator

    Definition Classes
    DecoratedProperty

  17. val decorator : Decorator

    Definition Classes
    Effect → DecoratedLabel

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

    set a new Decorator

    set a new Decorator

    Definition Classes
    Effect → DecoratedLabel

  19. def done : Success

    Definition Classes
    StandardResults

  20. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  21. def equals (a: Any): Boolean

    Definition Classes
    Effect → Equals → AnyRef → Any

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

  23. def failure : Failure

    Definition Classes
    StandardResults

  24. def finalize (): Unit

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

  25. def get : T

    alias for apply()

  26. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any

  27. def hashCode (): Int

    Definition Classes
    Effect → AnyRef → Any

  28. def header : Effect[T]

    use this Effect as a header in a table

  29. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  30. val label : String

  31. def labelStyles : String

    return the label styles

    return the label styles

    Definition Classes
    DecoratedLabel

  32. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  33. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  34. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  35. def pending : Pending

    Definition Classes
    StandardResults

  36. def productArity : Int

    Definition Classes
    Effect → Product

  37. def productElement (arg0: Int): Any

    Definition Classes
    Effect → Product

  38. def productIterator : Iterator[Any]

    Definition Classes
    Product

  39. def productPrefix : String

    Definition Classes
    Effect → Product

  40. def skipped : Skipped

    Definition Classes
    StandardResults

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

    set a new style for the label

    set a new style for the label

    Definition Classes
    DecoratedLabel

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

    set a new style for the value

    set a new style for the value

    Definition Classes
    DecoratedProperty

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

    set a new style

    set a new style

    Definition Classes
    DecoratedProperty

  44. def success : Success

    Definition Classes
    StandardResults

  45. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  46. def toString (): String

    returns

    "label"

    Definition Classes
    Effect → AnyRef → Any

  47. def todo : Pending

    Definition Classes
    StandardResults

  48. val value : Property[T]

  49. def valueOrResult : Either[Result, T]

  50. def valueStyles : String

    Definition Classes
    DecoratedProperty

  51. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  53. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  54. def wontdo : Success

    Definition Classes
    StandardResults

Deprecated Value Members

  1. def productElements : Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    use productIterator instead

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