tfw.tsm.Commit Maven / Gradle / Ivy
package tfw.tsm;
import tfw.tsm.ecd.ObjectECD;
/**
* The base class for component which process state in the commit phase of
* a transaction. Note that no state can be changed during the commit phase.
*/
public abstract class Commit extends BaseCommit {
/**
* Creates a commit component with the specified values.
* @param name the name of the commit component.
* @param triggerSinks the set of event channels which this
* commit component will process.
*/
public Commit(String name, ObjectECD[] triggerSinks) {
this(name, triggerSinks, null, null);
}
/**
* Creates a commit component with the specified values.
*
* @param name the name of the component.
*
* @param triggerSinks the set of event channel sinks which cause the
* commit components {@link #commit()} method to be called when their
* state is changed.
*
* @param nonTriggerSinks the set of event channel sinks whose state the
* commit component needs, but whose state changes do not cause the
* component to call it's {@link #commit()} method.
*
* @param initiators the set of {@link Initiator}s whose state changes
* this commit component will ignore. For example if an initiator sources
* events on event channel 'A' and 'A' is one of the event channels
* specified in the triggerSinks list, the {@link #commit()}
* method will not be called as a result of the initiator changing 'A's
* state.
*
* @throws IllegalArgumentException if triggerSinks == null.
* @throws IllegalArgumentException if triggerSinks.length == 0.
* @throws IllegalArgumentException if triggerSinks[i] == null.
*/
public Commit(String name, ObjectECD[] triggerSinks, ObjectECD[] nonTriggerSinks, Initiator[] initiators) {
super(name, triggerSinks, nonTriggerSinks, initiators);
}
}