public interface IBinding extends org.apache.hivemind.Locatable
IComponent
instances. The component doesn't care where the required value comes from, it simply requires
that a value be provided when needed.
Bindings are set inside the containing component's specification or template. Bindings may be invariant or dynamic (though that is irrelevant to the component). Components may also use a binding to write a value back through a property to some other object (typically, another component).
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDescription()
Returns a description of how the binding is used; this description
is localized and incorporated into some exception messages.
|
java.lang.Object |
getObject()
Returns the value of this binding.
|
java.lang.Object |
getObject(java.lang.Class type)
Returns the value for the binding after performing some basic checks.
|
boolean |
isInvariant()
Returns true if the value is invariant (not changing; the same value returned each time).
|
void |
setObject(java.lang.Object value)
Updates the value of the binding, if possible.
|
java.lang.Object getObject()
java.lang.Object getObject(java.lang.Class type)
Note: In release 4.0, the parameterName parameter was removed.
type
- if not null, the value must be assignable to the specific classBindingException
- if the value is not assignable to the specified typeboolean isInvariant()
ExpressionBinding
s may be marked invariant (as an
optimization).void setObject(java.lang.Object value)
BindingException
- If the binding is read only.java.lang.String getDescription()