|
|||||||||
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.JavaVariant
public class JavaVariant
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.simantics.databoard.accessor.Accessor |
---|
Accessor.Listener |
Constructor Summary | |
---|---|
JavaVariant(Accessor parent,
VariantBinding binding,
java.lang.Object object,
AccessorParams params)
|
Method Summary | ||
---|---|---|
void |
addListener(Accessor.Listener listener,
InterestSet interestSet,
AccessorReference path)
Place a listener to an accessor node. |
|
|
getAccessor(AccessorReference reference)
Get an accessor to a sub-container. |
|
VariantBinding |
getBinding()
|
|
|
getContentAccessor()
Get an accessor to the variant's content. |
|
DataType |
getContentType()
Get the type of the content |
|
java.lang.Object |
getContentValue(Binding contentBinding)
Get the content of this variant |
|
void |
removeListener(Accessor.Listener listener)
Remove a listener. |
|
void |
setContentValue(Binding valueBinding,
java.lang.Object newValue)
Set the content of this variant. |
|
void |
setValue(Binding variantBinding,
java.lang.Object newVariant)
Set a complete new value to the data container. |
|
VariantType |
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, getEmitter, getObject, getParams, getReadLock, 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 |
Constructor Detail |
---|
public JavaVariant(Accessor parent, VariantBinding binding, java.lang.Object object, AccessorParams params)
Method Detail |
---|
public VariantType type()
Accessor
type
in interface Accessor
type
in interface VariantAccessor
type
in class JavaObject
public VariantBinding getBinding()
getBinding
in class JavaObject
public <T extends Accessor> T getContentAccessor() throws AccessorConstructionException
VariantAccessor
getContentAccessor
in interface VariantAccessor
AccessorConstructionException
public <T extends Accessor> T getAccessor(AccessorReference reference) throws AccessorConstructionException
Accessor
InvalidatedEvent is thrown from the accessor if it is unlinked from the parent hierarchy.
getAccessor
in interface Accessor
reference
- component reference or null
to return _this_ accessor
AccessorConstructionException
public void setValue(Binding variantBinding, java.lang.Object newVariant) throws AccessorException
Accessor
InvalidatedEvent
. Writing the current value again may not emit an event. This is implementation specific.
Write is durable, once a the method returns successfully the value has been stored in the implmentation.
setValue
in interface Accessor
AccessorException
public java.lang.Object getContentValue(Binding contentBinding) throws AccessorException
VariantAccessor
getContentValue
in interface VariantAccessor
AccessorException
public DataType getContentType() throws AccessorException
VariantAccessor
getContentType
in interface VariantAccessor
AccessorException
public void setContentValue(Binding valueBinding, java.lang.Object newValue) throws AccessorException
VariantAccessor
Accessor.setValue(org.simantics.databoard.binding.Binding, Object)
which sets the _variant_ value.
setContentValue
in interface VariantAccessor
AccessorException
public void addListener(Accessor.Listener listener, InterestSet interestSet, AccessorReference path) 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.
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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |