org.squirrelframework.foundation.component.Observable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of squirrel-foundation Show documentation

foundation module of squirrel framework which provided event driven infrastructure and a finite state machine implementation.

There is a newer version: 0.3.10

Show newest version

package org.squirrelframework.foundation.component;

import java.lang.reflect.Method;

import org.squirrelframework.foundation.event.SquirrelEvent;

/**
 * This interface represents an observable object, or "data" in the subject-observer paradigm. 
 * It can be implemented to represent an object that the observer wants to have listened.
 * 
 * @author Henry.He
 *
 */
public interface Observable {
	
	/**
	 * @return whether the subject is notifiable
	 */
	boolean isNotifiable();
	
	/**
	 * Set notifiable of subject
	 * @param notifiable
	 */
	void setNotifiable(boolean notifiable);
	
	/**
	 * Add listener to observable subject.
	 * @param eventType type of event
	 * @param listener listener object
	 * @param method listener method
	 */
	void addListener(Class eventType, Object listener, Method method);
	
	/**
	 * Add listener to observable subject.
	 * @param eventType type of event
	 * @param listener listener object
	 * @param methodName name of listener method
	 */
	void addListener(Class eventType, Object listener, String methodName);
	
	/**
	 * Remove listener from observable subject.
	 * @param eventType type of event
	 * @param listener listener object
	 * @param methodName name of listener method
	 */
	void removeListener(Class eventType, Object listener, Method method);
	
	/**
	 * Remove listener to observable subject.
	 * @param eventType type of event
	 * @param listener listener object
	 * @param methodName name of listener method
	 */
	void removeListener(Class eventType, Object listener, String methodName);
	
	/**
	 * Add listener to observable subject.
	 * @param eventType type of event
	 * @param listener listener object
	 */
	void removeListener(Class eventType, Object listener);
	
	/**
	 * Remove all listeners
	 */
	void removeAllListeners();
	
	/**
	 * Fire event to notify all observers
	 * @param event based event
	 */
	void fireEvent(SquirrelEvent event);
}