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.
Attributes
- Companion
- object
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait Executableclass Objecttrait Matchableclass AnyShow all
Members list
Value members
Concrete methods
set a new value on the effect
set a new value on the effect
Attributes
set a new Decorator
set a new Decorator
Attributes
Compares the receiver object (this
) with the argument object (that
) for equivalence.
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 typeAny
,x.equals(x)
should returntrue
. - It is symmetric: for any instances
x
andy
of typeAny
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any instances
x
,y
, andz
of typeAny
ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
.
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.
Attributes
- 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
executing an effect executes the value and returns success unless there is an Error
Attributes
- Definition Classes
-
Executable
Calculate a hash code value for the object.
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.
Attributes
- Returns
-
the hash code value for this object.
- Definition Classes
-
Any
use this Effect as a header in a table
use this Effect as a header in a table
Attributes
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
Attributes
- Returns
-
a string representation of the object.
- Definition Classes
-
Any
Inherited methods
do the decoration
set a new Decorator for the label
do the decoration
set a new Decorator for the value
set a new Decorator
return the label styles
modify the result to return
modify the result to return
Attributes
- Inherited from:
- Executable
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
set a new style for the label
set a new style for the value
set a new style
Attributes
- Inherited from:
- DecoratedProperty