[jbpm-commits] JBoss JBPM SVN: r1942 - in jbpm4/pvm/trunk/modules/core/src: main/java/org/jbpm/pvm/internal/util and 4 other directories.

Author: tom.baeyens(a)jboss.com Date: 2008-08-20 10:10:41 -0400 (Wed, 20 Aug 2008) New Revision: 1942 Added: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/DefaultObservable.java jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/FilterListener.java jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/Listener.java jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/Observable.java Removed: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/util/ Modified: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/Descriptor.java jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/WireContext.java jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/descriptor/AbstractDescriptor.java jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/descriptor/HibernateSessionFactoryDescriptor.java jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/descriptor/JobExecutorDescriptor.java jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/operation/MethodInvokerListener.java jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/operation/SubscribeOperation.java jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/MethodSubscriptionTest.java jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/ObjectSubscriptionTest.java jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/SubscriptionTestCase.java jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/WireEventsSubscriptionTest.java jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/WireObservableTest.java Log: moved util classes to internal: JBPM-1418 Copied: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/DefaultObservable.java (from rev 1887, jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/util/DefaultObservable.java) =================================================================== --- jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/DefaultObservable.java (rev 0) +++ jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/DefaultObservable.java 2008-08-20 14:10:41 UTC (rev 1942) @@ -0,0 +1,74 @@ +package org.jbpm.pvm.internal.util; + +import java.util.ArrayList; +import java.util.List; + +import org.jbpm.pvm.PvmException; + +/** default implementation of the {@link Observable} interface. + * + * @author Tom Baeyens + */ +public class DefaultObservable implements Observable { + + protected List<Listener> listeners = null; + + public void addListener(Listener listener) { + if (listener==null) { + throw new PvmException("listener is null"); + } + if (listeners==null) { + listeners = new ArrayList<Listener>(); + } + listeners.add(listener); + } + + public void removeListener(Listener listener) { + if (listener==null) { + throw new PvmException("listener is null"); + } + if (listeners!=null) { + listeners.remove(listener); + } + } + + public Listener addListener(Listener listener, String eventName) { + if (eventName==null) { + throw new PvmException("eventName is null"); + } + + List<String> eventNames = new ArrayList<String>(); + eventNames.add(eventName); + + return addListener(listener, eventNames); + } + + + public Listener addListener(Listener listener, List<String> eventNames) { + if (listener==null) { + throw new PvmException("listener is null"); + } + if (eventNames==null) { + throw new PvmException("eventNames is null"); + } + FilterListener filterListener = new FilterListener(listener, eventNames); + addListener(filterListener); + return filterListener; + } + + public void fire(String eventName) { + fire(eventName, null); + } + + public void fire(String eventName, Object info) { + if (listeners!=null) { + for (Listener listener: listeners) { + listener.event(this, eventName, info); + } + } + } + + public List<Listener> getListeners() { + return listeners; + } +} Property changes on: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/DefaultObservable.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:mergeinfo + Name: svn:eol-style + LF Copied: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/FilterListener.java (from rev 1887, jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/util/FilterListener.java) =================================================================== --- jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/FilterListener.java (rev 0) +++ jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/FilterListener.java 2008-08-20 14:10:41 UTC (rev 1942) @@ -0,0 +1,56 @@ +package org.jbpm.pvm.internal.util; + +import java.util.ArrayList; +import java.util.List; + +import org.jbpm.pvm.PvmException; + +/** listener that only delegates events to a given listener if + * they pass the filter based on event names. */ +public class FilterListener implements Listener { + + protected Listener listener; + protected List<String> eventNames; + + public FilterListener(Listener listener, String eventName) { + if (listener==null) throw new PvmException("listener is null"); + this.listener = listener; + if (eventName==null) throw new PvmException("eventName is null"); + this.eventNames = new ArrayList<String>(); + this.eventNames.add(eventName); + } + + public FilterListener(Listener listener, List<String> eventNames) { + if (listener==null) throw new PvmException("listener is null"); + this.listener = listener; + if (eventNames==null) throw new PvmException("eventNames is null"); + this.eventNames = eventNames; + } + + public void event(Object source, String name, Object info) { + if (! isFiltered(name)) { + listener.event(source, name, info); + } + } + + public boolean isFiltered(String eventName) { + if (eventNames.contains(eventName)) { + return false; + } + return true; + } + + public boolean equals(Object object) { + if (object==null) return false; + if (object==this) return true; + if ( (object instanceof Listener) + && (listener.equals(object)) + ) { + return true; + } + return false; + } + public int hashCode() { + return 17+listener.hashCode(); + } +} \ No newline at end of file Property changes on: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/FilterListener.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:mergeinfo + Name: svn:eol-style + LF Copied: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/Listener.java (from rev 1887, jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/util/Listener.java) =================================================================== --- jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/Listener.java (rev 0) +++ jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/Listener.java 2008-08-20 14:10:41 UTC (rev 1942) @@ -0,0 +1,17 @@ +package org.jbpm.pvm.internal.util; + +/** listener to events that are produced by an {@link Observable}. + * + * @author Tom Baeyens + * @author Guillaume Porcher (documentation) + */ +public interface Listener { + + /** is called by the {@link Observable} when an event is fired. + * @param source {@link Observable} that fired the event. + * @param eventName name of the event. + * @param info more information about the fired event. See the concrete + * observable docs for more information about what information is provided. + */ + public void event(Object source, String eventName, Object info); +} Property changes on: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/Listener.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:mergeinfo + Name: svn:eol-style + LF Copied: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/Observable.java (from rev 1887, jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/util/Observable.java) =================================================================== --- jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/Observable.java (rev 0) +++ jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/Observable.java 2008-08-20 14:10:41 UTC (rev 1942) @@ -0,0 +1,52 @@ +package org.jbpm.pvm.internal.util; + +import java.util.List; + + +/** dispatches events to which {@link Listener listeners} can subscribe. + * Aka publish-subscribe. + * + * @see DefaultObservable a default implementation of this interface + * @author Tom Baeyens + */ +public interface Observable { + + /** subscribes a listener to every event + * @param listener is the object that will be notified on {@link #fire(String, Object) firing} of events. + */ + void addListener(Listener listener); + + /** removes a listener that was subscribed for every event + */ + void removeListener(Listener listener); + + /** subscribes the listener to receive event notifications only of the given eventName. Events with + * different eventNames will not be dispatched to the given listener. + * @param listener is the object that will be notified on {@link #fire(String, Object) firing} of events. + * @param eventName is the type of events the listener is interested in and this is mandatory. + * @return the {@link FilterListener} that is created as a wrapper for the given listener. That handle + * might be necessary to remove the listener later on. + * @throws NullPointerException in case listener or eventName is null. */ + Listener addListener(Listener listener, String eventName); + + /** subscribes the listener to receive event notifications only if event matches one of the + * given eventNames. Events with different eventNames will not be dispatched to the given listener. + * @param listener is the object that will be notified on {@link #fire(String, Object) firing} of events. + * @param eventNames is the type of events the listener is interested in and this is mandatory. + * @return the {@link FilterListener} that is created as a wrapper for the given listener. That handle + * might be necessary to remove the listener later on. + * @throws NullPointerException in case listener or eventName is null. */ + Listener addListener(Listener listener, List<String> eventNames); + + /** dispatches an event to the listeners. + * @param eventName identifies the type of event and is allowed to be null. + */ + void fire(String eventName); + + /** dispatches an event to the listeners. + * @param eventName identifies the type of event and is allowed to be null. + * @param info is the optional information that the observable wants to pass to it's listeners. + * Each observable should indicate which type of info it's passing for each event. + */ + void fire(String eventName, Object info); +} Property changes on: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/util/Observable.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:mergeinfo + Name: svn:eol-style + LF Modified: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/Descriptor.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/Descriptor.java 2008-08-20 14:07:10 UTC (rev 1941) +++ jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/Descriptor.java 2008-08-20 14:10:41 UTC (rev 1942) @@ -23,7 +23,7 @@ import java.io.Serializable; -import org.jbpm.pvm.util.Observable; +import org.jbpm.pvm.internal.util.Observable; /** * knows how an object can be created. Modified: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/WireContext.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/WireContext.java 2008-08-20 14:07:10 UTC (rev 1941) +++ jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/WireContext.java 2008-08-20 14:10:41 UTC (rev 1942) @@ -37,6 +37,8 @@ import org.jbpm.pvm.internal.log.Log; import org.jbpm.pvm.internal.model.ProcessElementImpl; import org.jbpm.pvm.internal.util.Closable; +import org.jbpm.pvm.internal.util.DefaultObservable; +import org.jbpm.pvm.internal.util.Observable; import org.jbpm.pvm.internal.wire.descriptor.AbstractDescriptor; import org.jbpm.pvm.internal.wire.descriptor.ObjectDescriptor; import org.jbpm.pvm.internal.wire.operation.FieldOperation; @@ -45,8 +47,6 @@ import org.jbpm.pvm.internal.wire.operation.PropertyOperation; import org.jbpm.pvm.internal.wire.operation.SubscribeOperation; import org.jbpm.pvm.internal.wire.xml.WireParser; -import org.jbpm.pvm.util.DefaultObservable; -import org.jbpm.pvm.util.Observable; /** * object factory that creates, initializes, wires and caches objects Modified: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/descriptor/AbstractDescriptor.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/descriptor/AbstractDescriptor.java 2008-08-20 14:07:10 UTC (rev 1941) +++ jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/descriptor/AbstractDescriptor.java 2008-08-20 14:10:41 UTC (rev 1942) @@ -23,10 +23,10 @@ import java.io.Serializable; +import org.jbpm.pvm.internal.util.DefaultObservable; import org.jbpm.pvm.internal.wire.Descriptor; import org.jbpm.pvm.internal.wire.WireContext; import org.jbpm.pvm.internal.wire.WireDefinition; -import org.jbpm.pvm.util.DefaultObservable; /** * base class for {@link Descriptor}s. Modified: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/descriptor/HibernateSessionFactoryDescriptor.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/descriptor/HibernateSessionFactoryDescriptor.java 2008-08-20 14:07:10 UTC (rev 1941) +++ jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/descriptor/HibernateSessionFactoryDescriptor.java 2008-08-20 14:10:41 UTC (rev 1942) @@ -22,11 +22,11 @@ package org.jbpm.pvm.internal.wire.descriptor; import org.jbpm.pvm.internal.log.Log; +import org.jbpm.pvm.internal.util.Listener; import org.jbpm.pvm.internal.wire.Descriptor; import org.jbpm.pvm.internal.wire.WireContext; import org.jbpm.pvm.internal.wire.WireDefinition; import org.jbpm.pvm.internal.wire.WireException; -import org.jbpm.pvm.util.Listener; import org.hibernate.SessionFactory; import org.hibernate.cfg.Configuration; Modified: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/descriptor/JobExecutorDescriptor.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/descriptor/JobExecutorDescriptor.java 2008-08-20 14:07:10 UTC (rev 1941) +++ jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/descriptor/JobExecutorDescriptor.java 2008-08-20 14:10:41 UTC (rev 1942) @@ -16,8 +16,8 @@ import org.jbpm.pvm.PvmException; import org.jbpm.pvm.internal.jobexecutor.JobExecutor; import org.jbpm.pvm.internal.log.Log; +import org.jbpm.pvm.internal.util.Listener; import org.jbpm.pvm.internal.wire.WireContext; -import org.jbpm.pvm.util.Listener; /** * @author Pascal Verdage Modified: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/operation/MethodInvokerListener.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/operation/MethodInvokerListener.java 2008-08-20 14:07:10 UTC (rev 1941) +++ jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/operation/MethodInvokerListener.java 2008-08-20 14:10:41 UTC (rev 1942) @@ -5,13 +5,13 @@ import java.util.List; import org.jbpm.pvm.internal.log.Log; +import org.jbpm.pvm.internal.util.Listener; +import org.jbpm.pvm.internal.util.Observable; import org.jbpm.pvm.internal.util.ReflectUtil; import org.jbpm.pvm.internal.wire.WireContext; import org.jbpm.pvm.internal.wire.WireException; import org.jbpm.pvm.internal.wire.descriptor.ArgDescriptor; import org.jbpm.pvm.internal.wire.descriptor.ObjectDescriptor; -import org.jbpm.pvm.util.Listener; -import org.jbpm.pvm.util.Observable; /** Modified: jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/operation/SubscribeOperation.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/operation/SubscribeOperation.java 2008-08-20 14:07:10 UTC (rev 1941) +++ jbpm4/pvm/trunk/modules/core/src/main/java/org/jbpm/pvm/internal/wire/operation/SubscribeOperation.java 2008-08-20 14:10:41 UTC (rev 1942) @@ -7,14 +7,14 @@ import org.jbpm.pvm.env.Context; import org.jbpm.pvm.env.Environment; import org.jbpm.pvm.internal.log.Log; +import org.jbpm.pvm.internal.util.FilterListener; +import org.jbpm.pvm.internal.util.Listener; +import org.jbpm.pvm.internal.util.Observable; import org.jbpm.pvm.internal.wire.Descriptor; import org.jbpm.pvm.internal.wire.WireContext; import org.jbpm.pvm.internal.wire.WireDefinition; import org.jbpm.pvm.internal.wire.WireException; import org.jbpm.pvm.internal.wire.descriptor.ArgDescriptor; -import org.jbpm.pvm.util.FilterListener; -import org.jbpm.pvm.util.Listener; -import org.jbpm.pvm.util.Observable; /** Modified: jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/MethodSubscriptionTest.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/MethodSubscriptionTest.java 2008-08-20 14:07:10 UTC (rev 1941) +++ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/MethodSubscriptionTest.java 2008-08-20 14:10:41 UTC (rev 1942) @@ -3,9 +3,9 @@ import org.jbpm.pvm.env.Environment; import org.jbpm.pvm.env.EnvironmentFactory; import org.jbpm.pvm.env.PvmEnvironmentFactory; +import org.jbpm.pvm.internal.util.DefaultObservable; +import org.jbpm.pvm.internal.util.Observable; import org.jbpm.pvm.internal.wire.WireException; -import org.jbpm.pvm.util.DefaultObservable; -import org.jbpm.pvm.util.Observable; /** * Test subscription using a specified method. Modified: jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/ObjectSubscriptionTest.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/ObjectSubscriptionTest.java 2008-08-20 14:07:10 UTC (rev 1941) +++ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/ObjectSubscriptionTest.java 2008-08-20 14:10:41 UTC (rev 1942) @@ -24,9 +24,9 @@ import org.jbpm.pvm.env.Environment; import org.jbpm.pvm.env.EnvironmentFactory; import org.jbpm.pvm.env.PvmEnvironmentFactory; +import org.jbpm.pvm.internal.util.DefaultObservable; +import org.jbpm.pvm.internal.util.Observable; import org.jbpm.pvm.internal.wire.WireException; -import org.jbpm.pvm.util.DefaultObservable; -import org.jbpm.pvm.util.Observable; /** * @author Tom Baeyens Modified: jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/SubscriptionTestCase.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/SubscriptionTestCase.java 2008-08-20 14:07:10 UTC (rev 1941) +++ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/SubscriptionTestCase.java 2008-08-20 14:10:41 UTC (rev 1942) @@ -24,8 +24,8 @@ import java.util.ArrayList; import java.util.List; +import org.jbpm.pvm.internal.util.Listener; import org.jbpm.pvm.test.base.JbpmTestCase; -import org.jbpm.pvm.util.Listener; /** * @author Tom Baeyens Modified: jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/WireEventsSubscriptionTest.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/WireEventsSubscriptionTest.java 2008-08-20 14:07:10 UTC (rev 1941) +++ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/WireEventsSubscriptionTest.java 2008-08-20 14:10:41 UTC (rev 1942) @@ -24,10 +24,10 @@ import org.jbpm.pvm.env.Environment; import org.jbpm.pvm.env.EnvironmentFactory; import org.jbpm.pvm.env.PvmEnvironmentFactory; +import org.jbpm.pvm.internal.util.DefaultObservable; +import org.jbpm.pvm.internal.util.Observable; import org.jbpm.pvm.internal.wire.WireObjectEventInfo; import org.jbpm.pvm.internal.wire.descriptor.ObjectDescriptor; -import org.jbpm.pvm.util.DefaultObservable; -import org.jbpm.pvm.util.Observable; /** * @author Tom Baeyens Modified: jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/WireObservableTest.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/WireObservableTest.java 2008-08-20 14:07:10 UTC (rev 1941) +++ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/internal/wire/WireObservableTest.java 2008-08-20 14:10:41 UTC (rev 1942) @@ -24,11 +24,11 @@ import java.util.List; import org.jbpm.pvm.test.base.JbpmTestCase; -import org.jbpm.pvm.util.Listener; import org.jbpm.pvm.env.Context; import org.jbpm.pvm.env.Environment; import org.jbpm.pvm.env.EnvironmentFactory; import org.jbpm.pvm.env.PvmEnvironmentFactory; +import org.jbpm.pvm.internal.util.Listener; import org.jbpm.pvm.internal.wire.WireContext; /**