|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.simantics.databoard.accessor.java.JavaObject
org.simantics.databoard.accessor.java.JavaOptional
public class JavaOptional
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.simantics.databoard.accessor.Accessor |
---|
Accessor.Listener |
Constructor Summary | |
---|---|
JavaOptional(Accessor parent,
OptionalBinding binding,
java.lang.Object object,
AccessorParams params)
|
Method Summary | ||
---|---|---|
void |
addListener(Accessor.Listener listener,
InterestSet interestSet,
ChildReference path,
java.util.concurrent.Executor executor)
Place a listener to an accessor node. |
|
OptionalBinding |
getBinding()
|
|
|
getComponent(ChildReference reference)
Open an accessor to a child. |
|
|
getComponentAccessor()
Get accessor to the component value or null if there is no component value |
|
java.lang.Object |
getComponentValue(Binding componentBinding)
Return component value if there is a component value. |
|
boolean |
hasValue()
Return true if there is a value assigned |
|
void |
removeListener(Accessor.Listener listener)
Remove a listener. |
|
void |
setComponentValue(Binding binding,
java.lang.Object value)
Set a new component value. |
|
void |
setNoValue()
Sets no value. |
|
void |
setValue(Binding binding,
java.lang.Object newValue)
Set a new value. |
|
OptionalType |
type()
Get structural represtentation of the accessor presented in databoard's type system. |
Methods inherited from class org.simantics.databoard.accessor.java.JavaObject |
---|
apply, createAccessor, createSubAccessor, getObject, getParams, getReadLock, getValue, getValue, getWriteLock, notifyValueChanged, toString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.simantics.databoard.accessor.Accessor |
---|
apply, getValue, getValue |
Constructor Detail |
---|
public JavaOptional(Accessor parent, OptionalBinding binding, java.lang.Object object, AccessorParams params)
Method Detail |
---|
public OptionalBinding getBinding()
getBinding
in class JavaObject
public OptionalType type()
Accessor
type
in interface Accessor
type
in interface OptionalAccessor
type
in class JavaObject
public <T extends Accessor> T getComponentAccessor() throws AccessorConstructionException
OptionalAccessor
null
if there is no component value
getComponentAccessor
in interface OptionalAccessor
null
AccessorConstructionException
public java.lang.Object getComponentValue(Binding componentBinding) throws AccessorException
OptionalAccessor
getComponentValue
in interface OptionalAccessor
componentBinding
- component binding
AccessorException
public void addListener(Accessor.Listener listener, InterestSet interestSet, ChildReference path, java.util.concurrent.Executor executor) throws AccessorException
Accessor
When events are emited and in which thread processed is implementation specific. It is also implementation specific, whether the object can be mutated in the listener or whether it has to be done afterwards.
In many implementations there is a pluggable event handling strategy EventEmitter. The default behaviour is to emit events as they are spawned in the current thread.
There is a reference in each event instance that describes the path from the accessor where listener was placed to the node to which the event applies to.
Listener is attached to the object that holds the value at the time at the of the adding. For example, If a listener is attached to an array of element at index 3, and a new value is inserted at position 2, the listener still monitors the same container, which is now at index 4. The references of incoming the events are modified to have the new index.
Also, if a new value is assigned to the parent of an object that is listened, the listener keeps on monitoring the new value at the same reference. This doesn't apply when a new value is set to a union of different tag, to a variant with a new type, or value is removed from Optional type. In these two cases the listener is invalidated.
See ChangeSet
is an implementation that collects events.
Executor argument determines the thread where the onEvents method is
handled. null argument denotes current thread.
addListener
in interface Accessor
addListener
in class JavaObject
path
- path to the accessor or null
. This is used in the events the accessor produces
AccessorException
collects events
public void removeListener(Accessor.Listener listener) throws AccessorException
Accessor
removeListener
in interface Accessor
removeListener
in class JavaObject
AccessorException
public <T extends Accessor> T getComponent(ChildReference reference) throws AccessorConstructionException
Accessor
InvalidatedEvent is thrown from the accessor if it is unlinked from the parent hierarchy.
getComponent
in interface Accessor
reference
- component reference path or null
to return _this_ accessor
AccessorConstructionException
public void setValue(Binding binding, java.lang.Object newValue) throws AccessorException
OptionalAccessor
setValue
in interface Accessor
setValue
in interface OptionalAccessor
binding
- of component typenewValue
- component value
AccessorException
public boolean hasValue() throws AccessorException
OptionalAccessor
hasValue
in interface OptionalAccessor
AccessorException
public void setNoValue() throws AccessorException
OptionalAccessor
setNoValue
in interface OptionalAccessor
AccessorException
public void setComponentValue(Binding binding, java.lang.Object value) throws AccessorException
OptionalAccessor
setComponentValue
in interface OptionalAccessor
AccessorException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |