org.valkyriercp.binding.value.CommitTrigger Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of valkyrie-rcp-core Show documentation

There is a newer version: 1.3

package org.valkyriercp.binding.value;

import org.valkyriercp.util.EventListenerListHelper;

import java.util.Iterator;

/**
 * A class that can be used to trigger an event on a group of objects. Mainly
 * intended to be used to trigger flush/revert in
 * BufferedValueModel but is useful in general.
 *
 * @author Keith Donald
 * @author Oliver Hutchison
 */
public class CommitTrigger {

	private final EventListenerListHelper listeners = new EventListenerListHelper(CommitTriggerListener.class);

	/**
	 * Constructs a CommitTrigger.
	 */
	public CommitTrigger() {
	}

	/**
	 * Triggers a commit event.
	 */
	public void commit() {
		for (Iterator i = listeners.iterator(); i.hasNext();) {
			((CommitTriggerListener) i.next()).commit();
		}
	}

	/**
	 * Triggers a revert event.
	 */
	public void revert() {
		for (Iterator i = listeners.iterator(); i.hasNext();) {
			((CommitTriggerListener) i.next()).revert();
		}
	}

	/**
	 * Adds the provided listener to the list of listeners that will be notified
	 * whenever a commit or revert event is fired.
	 *
	 * @param listener the CommitTriggerListener to add
	 */
	public void addCommitTriggerListener(CommitTriggerListener listener) {
		listeners.add(listener);
	}

	/**
	 * Removed the provided listener to the list of listeners that will be
	 * notified whenever a commit or revert event is fired.
	 *
	 * @param listener the CommitTriggerListener to remove
	 */
	public void removeCommitTriggerListener(CommitTriggerListener listener) {
		listeners.remove(listener);
	}
}