Effect

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

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.

Companion:: object

trait Serializable

trait Product

trait Equals

trait DecoratedProperty[Effect[T]]

trait DecoratedLabel[Effect[T]]

trait Executable

class Object

trait Matchable

class Any

Value members

Concrete methods

set a new value on the effect

set a new Decorator

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

It is reflexive: for any instance x of type Any, x.equals(x) should return true.
It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters:

that: the object to compare against this object for equality.

Returns:

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes

Equals -> Any

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

Definition Classes: Executable

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Returns:: the hash code value for this object.
Definition Classes: Any