This does not mark the method, and so should be used in combination with {@link Subscribe}. + * + * @author Cliff Biffle + * @since 10.0 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.METHOD) +public @interface AllowConcurrentEvents {} Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/AsyncEventBus.java =================================================================== --- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/AsyncEventBus.java (revision 34000) +++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/AsyncEventBus.java (revision 34000) @@ -0,0 +1,62 @@ +/* + * Copyright (C) 2007 The Guava Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except + * in compliance with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under the License + * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express + * or implied. See the License for the specific language governing permissions and limitations under + * the License. + */ + +package org.openstreetmap.josm.eventbus; + +import java.util.concurrent.Executor; + +/** + * An {@link EventBus} that takes the Executor of your choice and uses it to dispatch events, + * allowing dispatch to occur asynchronously. + * + * @author Cliff Biffle + * @since 10.0 + */ +public class AsyncEventBus extends EventBus { + + /** + * Creates a new AsyncEventBus that will use {@code executor} to dispatch events. Assigns {@code + * identifier} as the bus's name for logging purposes. + * + * @param identifier short name for the bus, for logging purposes. + * @param executor Executor to use to dispatch events. It is the caller's responsibility to shut + * down the executor after the last event has been posted to this event bus. + */ + public AsyncEventBus(String identifier, Executor executor) { + super(identifier, executor, Dispatcher.legacyAsync(), LoggingHandler.INSTANCE); + } + + /** + * Creates a new AsyncEventBus that will use {@code executor} to dispatch events. + * + * @param executor Executor to use to dispatch events. It is the caller's responsibility to shut + * down the executor after the last event has been posted to this event bus. + * @param subscriberExceptionHandler Handler used to handle exceptions thrown from subscribers. + * See {@link SubscriberExceptionHandler} for more information. + * @since 16.0 + */ + public AsyncEventBus(Executor executor, SubscriberExceptionHandler subscriberExceptionHandler) { + super("default", executor, Dispatcher.legacyAsync(), subscriberExceptionHandler); + } + + /** + * Creates a new AsyncEventBus that will use {@code executor} to dispatch events. + * + * @param executor Executor to use to dispatch events. It is the caller's responsibility to shut + * down the executor after the last event has been posted to this event bus. + */ + public AsyncEventBus(Executor executor) { + super("default", executor, Dispatcher.legacyAsync(), LoggingHandler.INSTANCE); + } +} Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/DeadEvent.java =================================================================== --- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/DeadEvent.java (revision 34000) +++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/DeadEvent.java (revision 34000) @@ -0,0 +1,68 @@ +/* + * Copyright (C) 2007 The Guava Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except + * in compliance with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under the License + * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express + * or implied. See the License for the specific language governing permissions and limitations under + * the License. + */ + +package org.openstreetmap.josm.eventbus; + +import java.util.Objects; + +/** + * Wraps an event that was posted, but which had no subscribers and thus could not be delivered. + * + *
Registering a DeadEvent subscriber is useful for debugging or logging, as it can detect + * misconfigurations in a system's event distribution. + * + * @author Cliff Biffle + * @since 10.0 + */ +public class DeadEvent { + + private final Object source; + private final Object event; + + /** + * Creates a new DeadEvent. + * + * @param source object broadcasting the DeadEvent (generally the {@link EventBus}). + * @param event the event that could not be delivered. + */ + public DeadEvent(Object source, Object event) { + this.source = Objects.requireNonNull(source); + this.event = Objects.requireNonNull(event); + } + + /** + * Returns the object that originated this event (not the object that originated the + * wrapped event). This is generally an {@link EventBus}. + * + * @return the source of this event. + */ + public Object getSource() { + return source; + } + + /** + * Returns the wrapped, 'dead' event, which the system was unable to deliver to any registered + * subscriber. + * + * @return the 'dead' event that could not be delivered. + */ + public Object getEvent() { + return event; + } + + @Override + public String toString() { + return "DeadEvent [source=" + source + ", event=" + event + ']'; + } +} Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/Dispatcher.java =================================================================== --- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/Dispatcher.java (revision 34000) +++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/Dispatcher.java (revision 34000) @@ -0,0 +1,189 @@ +/* + * Copyright (C) 2014 The Guava Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except + * in compliance with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under the License + * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express + * or implied. See the License for the specific language governing permissions and limitations under + * the License. + */ + +package org.openstreetmap.josm.eventbus; + +import java.util.ArrayDeque; +import java.util.Iterator; +import java.util.Objects; +import java.util.Queue; +import java.util.concurrent.ConcurrentLinkedQueue; + +/** + * Handler for dispatching events to subscribers, providing different event ordering guarantees that + * make sense for different situations. + * + *
Note: The dispatcher is orthogonal to the subscriber's {@code Executor}. The dispatcher + * controls the order in which events are dispatched, while the executor controls how (i.e. on which + * thread) the subscriber is actually called when an event is dispatched to it. + * + * @author Colin Decker + */ +abstract class Dispatcher { + + /** + * Returns a dispatcher that queues events that are posted reentrantly on a thread that is already + * dispatching an event, guaranteeing that all events posted on a single thread are dispatched to + * all subscribers in the order they are posted. + * + *
When all subscribers are dispatched to using a direct executor (which dispatches on
+ * the same thread that posts the event), this yields a breadth-first dispatch order on each
+ * thread. That is, all subscribers to a single event A will be called before any subscribers to
+ * any events B and C that are posted to the event bus by the subscribers to A.
+ */
+ static Dispatcher perThreadDispatchQueue() {
+ return new PerThreadQueuedDispatcher();
+ }
+
+ /**
+ * Returns a dispatcher that queues events that are posted in a single global queue. This behavior
+ * matches the original behavior of AsyncEventBus exactly, but is otherwise not especially useful.
+ * For async dispatch, an {@linkplain #immediate() immediate} dispatcher should generally be
+ * preferable.
+ */
+ static Dispatcher legacyAsync() {
+ return new LegacyAsyncDispatcher();
+ }
+
+ /**
+ * Returns a dispatcher that dispatches events to subscribers immediately as they're posted
+ * without using an intermediate queue to change the dispatch order. This is effectively a
+ * depth-first dispatch order, vs. breadth-first when using a queue.
+ */
+ static Dispatcher immediate() {
+ return ImmediateDispatcher.INSTANCE;
+ }
+
+ /** Dispatches the given {@code event} to the given {@code subscribers}. */
+ abstract void dispatch(Object event, Iterator The EventBus allows publish-subscribe-style communication between components without requiring
+ * the components to explicitly register with one another (and thus be aware of each other). It is
+ * designed exclusively to replace traditional Java in-process event distribution using explicit
+ * registration. It is not a general-purpose publish-subscribe system, nor is it intended
+ * for interprocess communication.
+ *
+ * To receive events, an object should:
+ *
+ * To post an event, simply provide the event object to the {@link #post(Object)} method. The
+ * EventBus instance will determine the type of event and route it to all registered listeners.
+ *
+ * Events are routed based on their type — an event will be delivered to any subscriber for
+ * any type to which the event is assignable. This includes implemented interfaces, all
+ * superclasses, and all interfaces implemented by superclasses.
+ *
+ * When {@code post} is called, all registered subscribers for an event are run in sequence, so
+ * subscribers should be reasonably quick. If an event may trigger an extended process (such as a
+ * database load), spawn a thread or queue it for later. (For a convenient way to do this, use an
+ * {@link AsyncEventBus}.)
+ *
+ * Event subscriber methods must accept only one argument: the event.
+ *
+ * Subscribers should not, in general, throw. If they do, the EventBus will catch and log the
+ * exception. This is rarely the right solution for error handling and should not be relied upon; it
+ * is intended solely to help find problems during development.
+ *
+ * The EventBus guarantees that it will not call a subscriber method from multiple threads
+ * simultaneously, unless the method explicitly allows it by bearing the {@link
+ * AllowConcurrentEvents} annotation. If this annotation is not present, subscriber methods need not
+ * worry about being reentrant, unless also called from outside the EventBus.
+ *
+ * If an event is posted, but no registered subscribers can accept it, it is considered "dead."
+ * To give the system a second chance to handle dead events, they are wrapped in an instance of
+ * {@link DeadEvent} and reposted.
+ *
+ * If a subscriber for a supertype of all events (such as Object) is registered, no event will
+ * ever be considered dead, and no DeadEvents will be generated. Accordingly, while DeadEvent
+ * extends {@link Object}, a subscriber registered to receive any Object will never receive a
+ * DeadEvent.
+ *
+ * This class is safe for concurrent use.
+ *
+ * See the Guava User Guide article on {@code EventBus}.
+ *
+ * @author Cliff Biffle
+ * @since 10.0
+ */
+public class EventBus {
+
+ private static final Logger logger = Logger.getLogger(EventBus.class.getName());
+
+ private final String identifier;
+ private final Executor executor;
+ private final SubscriberExceptionHandler exceptionHandler;
+
+ private final SubscriberRegistry subscribers = new SubscriberRegistry(this);
+ private final Dispatcher dispatcher;
+
+ enum DirectExecutor implements Executor {
+ INSTANCE;
+
+ @Override
+ public void execute(Runnable command) {
+ command.run();
+ }
+ }
+
+ /** Creates a new EventBus named "default". */
+ public EventBus() {
+ this("default");
+ }
+
+ /**
+ * Creates a new EventBus with the given {@code identifier}.
+ *
+ * @param identifier a brief name for this bus, for logging purposes. Should be a valid Java
+ * identifier.
+ */
+ public EventBus(String identifier) {
+ this(
+ identifier,
+ DirectExecutor.INSTANCE,
+ Dispatcher.perThreadDispatchQueue(),
+ LoggingHandler.INSTANCE);
+ }
+
+ /**
+ * Creates a new EventBus with the given {@link SubscriberExceptionHandler}.
+ *
+ * @param exceptionHandler Handler for subscriber exceptions.
+ * @since 16.0
+ */
+ public EventBus(SubscriberExceptionHandler exceptionHandler) {
+ this(
+ "default",
+ DirectExecutor.INSTANCE,
+ Dispatcher.perThreadDispatchQueue(),
+ exceptionHandler);
+ }
+
+ EventBus(
+ String identifier,
+ Executor executor,
+ Dispatcher dispatcher,
+ SubscriberExceptionHandler exceptionHandler) {
+ this.identifier = Objects.requireNonNull(identifier);
+ this.executor = Objects.requireNonNull(executor);
+ this.dispatcher = Objects.requireNonNull(dispatcher);
+ this.exceptionHandler = Objects.requireNonNull(exceptionHandler);
+ }
+
+ /**
+ * Returns the identifier for this event bus.
+ * @return the identifier for this event bus
+ *
+ * @since 19.0
+ */
+ public final String identifier() {
+ return identifier;
+ }
+
+ /** Returns the default executor this event bus uses for dispatching events to subscribers. */
+ final Executor executor() {
+ return executor;
+ }
+
+ /** Handles the given exception thrown by a subscriber with the given context. */
+ void handleSubscriberException(Throwable e, SubscriberExceptionContext context) {
+ Objects.requireNonNull(e);
+ Objects.requireNonNull(context);
+ try {
+ exceptionHandler.handleException(e, context);
+ } catch (Throwable e2) {
+ // if the handler threw an exception... well, just log it
+ logger.log(
+ Level.SEVERE,
+ String.format(Locale.ROOT, "Exception %s thrown while handling exception: %s", e2, e),
+ e2);
+ }
+ }
+
+ /**
+ * Registers all subscriber methods on {@code object} to receive events.
+ *
+ * @param object object whose subscriber methods should be registered.
+ */
+ public void register(Object object) {
+ subscribers.register(object);
+ }
+
+ /**
+ * Unregisters all subscriber methods on a registered {@code object}.
+ *
+ * @param object object whose subscriber methods should be unregistered.
+ * @throws IllegalArgumentException if the object was not previously registered.
+ */
+ public void unregister(Object object) {
+ subscribers.unregister(object);
+ }
+
+ /**
+ * Posts an event to all registered subscribers. This method will return successfully after the
+ * event has been posted to all subscribers, and regardless of any exceptions thrown by
+ * subscribers.
+ *
+ * If no subscribers have been subscribed for {@code event}'s class, and {@code event} is not
+ * already a {@link DeadEvent}, it will be wrapped in a DeadEvent and reposted.
+ *
+ * @param event event to post.
+ */
+ public void post(Object event) {
+ Iterator If no subscribers have been subscribed for {@code event}'s class, and {@code event} is not
+ * already a {@link DeadEvent}, it will be wrapped in a DeadEvent and reposted.
+ *
+ * @param event event to post.
+ * @see EventBus#post
+ */
+ public static void post(Object event) {
+ BUS.post(event);
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/Subscribe.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/Subscribe.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/Subscribe.java (revision 34000)
@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2007 The Guava Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package org.openstreetmap.josm.eventbus;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Marks a method as an event subscriber.
+ *
+ * The type of event will be indicated by the method's first (and only) parameter. If this
+ * annotation is applied to methods with zero parameters, or more than one parameter, the object
+ * containing the method will not be able to register for event delivery from the {@link EventBus}.
+ *
+ * Unless also annotated with @{@link AllowConcurrentEvents}, event subscriber methods will be
+ * invoked serially by each event bus that they are registered with.
+ *
+ * @author Cliff Biffle
+ * @since 10.0
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.METHOD)
+public @interface Subscribe {}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/Subscriber.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/Subscriber.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/Subscriber.java (revision 34000)
@@ -0,0 +1,142 @@
+/*
+ * Copyright (C) 2014 The Guava Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package org.openstreetmap.josm.eventbus;
+
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.util.Objects;
+import java.util.concurrent.Executor;
+
+/**
+ * A subscriber method on a specific object, plus the executor that should be used for dispatching
+ * events to it.
+ *
+ * Two subscribers are equivalent when they refer to the same method on the same object (not
+ * class). This property is used to ensure that no subscriber method is registered more than once.
+ *
+ * @author Colin Decker
+ */
+class Subscriber {
+
+ /** Creates a {@code Subscriber} for {@code method} on {@code listener}. */
+ static Subscriber create(EventBus bus, Object listener, Method method) {
+ return isDeclaredThreadSafe(method)
+ ? new Subscriber(bus, listener, method)
+ : new SynchronizedSubscriber(bus, listener, method);
+ }
+
+ /** The event bus this subscriber belongs to. */
+ private EventBus bus;
+
+ /** The object with the subscriber method. */
+ final Object target;
+
+ /** Subscriber method. */
+ private final Method method;
+
+ /** Executor to use for dispatching events to this subscriber. */
+ private final Executor executor;
+
+ private Subscriber(EventBus bus, Object target, Method method) {
+ this.bus = bus;
+ this.target = Objects.requireNonNull(target);
+ this.method = method;
+ method.setAccessible(true);
+
+ this.executor = bus.executor();
+ }
+
+ /** Dispatches {@code event} to this subscriber using the proper executor. */
+ final void dispatchEvent(final Object event) {
+ executor.execute(
+ new Runnable() {
+ @Override
+ public void run() {
+ try {
+ invokeSubscriberMethod(event);
+ } catch (InvocationTargetException e) {
+ bus.handleSubscriberException(e.getCause(), context(event));
+ }
+ }
+ });
+ }
+
+ /**
+ * Invokes the subscriber method. This method can be overridden to make the invocation
+ * synchronized.
+ */
+ void invokeSubscriberMethod(Object event) throws InvocationTargetException {
+ try {
+ method.invoke(target, Objects.requireNonNull(event));
+ } catch (IllegalArgumentException e) {
+ throw new Error("Method rejected target/argument: " + event, e);
+ } catch (IllegalAccessException e) {
+ throw new Error("Method became inaccessible: " + event, e);
+ } catch (InvocationTargetException e) {
+ if (e.getCause() instanceof Error) {
+ throw (Error) e.getCause();
+ }
+ throw e;
+ }
+ }
+
+ /** Gets the context for the given event. */
+ private SubscriberExceptionContext context(Object event) {
+ return new SubscriberExceptionContext(bus, event, target, method);
+ }
+
+ @Override
+ public final int hashCode() {
+ return (31 + method.hashCode()) * 31 + System.identityHashCode(target);
+ }
+
+ @Override
+ public final boolean equals(Object obj) {
+ if (obj instanceof Subscriber) {
+ Subscriber that = (Subscriber) obj;
+ // Use == so that different equal instances will still receive events.
+ // We only guard against the case that the same object is registered
+ // multiple times
+ return target == that.target && method.equals(that.method);
+ }
+ return false;
+ }
+
+ /**
+ * Checks whether {@code method} is thread-safe, as indicated by the presence of the {@link
+ * AllowConcurrentEvents} annotation.
+ */
+ private static boolean isDeclaredThreadSafe(Method method) {
+ return method.getAnnotation(AllowConcurrentEvents.class) != null;
+ }
+
+ /**
+ * Subscriber that synchronizes invocations of a method to ensure that only one thread may enter
+ * the method at a time.
+ */
+ static final class SynchronizedSubscriber extends Subscriber {
+
+ private SynchronizedSubscriber(EventBus bus, Object target, Method method) {
+ super(bus, target, method);
+ }
+
+ @Override
+ void invokeSubscriberMethod(Object event) throws InvocationTargetException {
+ synchronized (this) {
+ super.invokeSubscriberMethod(event);
+ }
+ }
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/SubscriberExceptionContext.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/SubscriberExceptionContext.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/SubscriberExceptionContext.java (revision 34000)
@@ -0,0 +1,68 @@
+/*
+ * Copyright (C) 2013 The Guava Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package org.openstreetmap.josm.eventbus;
+
+import java.lang.reflect.Method;
+import java.util.Objects;
+
+/**
+ * Context for an exception thrown by a subscriber.
+ *
+ * @since 16.0
+ */
+public class SubscriberExceptionContext {
+ private final EventBus eventBus;
+ private final Object event;
+ private final Object subscriber;
+ private final Method subscriberMethod;
+
+ /**
+ * @param eventBus The {@link EventBus} that handled the event and the subscriber. Useful for
+ * broadcasting a a new event based on the error.
+ * @param event The event object that caused the subscriber to throw.
+ * @param subscriber The source subscriber context.
+ * @param subscriberMethod the subscribed method.
+ */
+ SubscriberExceptionContext(
+ EventBus eventBus, Object event, Object subscriber, Method subscriberMethod) {
+ this.eventBus = Objects.requireNonNull(eventBus);
+ this.event = Objects.requireNonNull(event);
+ this.subscriber = Objects.requireNonNull(subscriber);
+ this.subscriberMethod = Objects.requireNonNull(subscriberMethod);
+ }
+
+ /**
+ * @return The {@link EventBus} that handled the event and the subscriber. Useful for broadcasting
+ * a a new event based on the error.
+ */
+ public EventBus getEventBus() {
+ return eventBus;
+ }
+
+ /** @return The event object that caused the subscriber to throw. */
+ public Object getEvent() {
+ return event;
+ }
+
+ /** @return The object context that the subscriber was called on. */
+ public Object getSubscriber() {
+ return subscriber;
+ }
+
+ /** @return The subscribed method that threw the exception. */
+ public Method getSubscriberMethod() {
+ return subscriberMethod;
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/SubscriberExceptionHandler.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/SubscriberExceptionHandler.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/SubscriberExceptionHandler.java (revision 34000)
@@ -0,0 +1,29 @@
+/*
+ * Copyright (C) 2013 The Guava Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package org.openstreetmap.josm.eventbus;
+
+/**
+ * Handler for exceptions thrown by event subscribers.
+ *
+ * @since 16.0
+ */
+public interface SubscriberExceptionHandler {
+ /**
+ * Handles exceptions thrown by subscribers.
+ * @param exception exception
+ * @param context context
+ */
+ void handleException(Throwable exception, SubscriberExceptionContext context);
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/SubscriberRegistry.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/SubscriberRegistry.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/eventbus/SubscriberRegistry.java (revision 34000)
@@ -0,0 +1,248 @@
+/*
+ * Copyright (C) 2014 The Guava Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package org.openstreetmap.josm.eventbus;
+
+import java.lang.reflect.Method;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.Objects;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
+import java.util.concurrent.CopyOnWriteArraySet;
+import java.util.stream.Collectors;
+
+import org.openstreetmap.josm.tools.MultiMap;
+
+/**
+ * Registry of subscribers to a single event bus.
+ *
+ * @author Colin Decker
+ */
+final class SubscriberRegistry {
+
+ /**
+ * All registered subscribers, indexed by event type.
+ *
+ * The {@link CopyOnWriteArraySet} values make it easy and relatively lightweight to get an
+ * immutable snapshot of all current subscribers to an event without any locking.
+ */
+ private final ConcurrentMap To find the first non-null element in an iterable, use {@code Iterables.find(iterable,
+ * Predicates.notNull())}. For varargs, use {@code Iterables.find(Arrays.asList(a, b, c, ...),
+ * Predicates.notNull())}, static importing as necessary.
+ *
+ * Note: if {@code first} is represented as an {@link Optional}, this can be
+ * accomplished with {@link Optional#or(Object) first.or(second)}. That approach also allows for
+ * lazy evaluation of the fallback instance, using {@link Optional#or(Supplier)
+ * first.or(supplier)}.
+ *
+ * @return {@code first} if it is non-null; otherwise {@code second} if it is non-null
+ * @throws NullPointerException if both {@code first} and {@code second} are null
+ * @since 18.0 (since 3.0 as {@code Objects.firstNonNull()}).
+ */
+ static See the Guava User Guide article on {@code EventBus}.
+ *
+ * Converting an existing EventListener-based system to use the EventBus is easy.
+ *
+ * To listen for a specific flavor of event (say, a CustomerChangeEvent)...
+ *
+ * To register your listener methods with the event producers...
+ *
+ * To listen for a common event supertype (such as EventObject or Object)...
+ *
+ * To listen for and detect events that were dispatched without listeners...
+ *
+ * To keep track of listeners to your events...
+ *
+ * To dispatch an event to listeners...
+ *
+ * The EventBus system and code use the following terms to discuss event distribution:
+ *
+ * The Event Bus doesn't specify how you use it; there's nothing stopping your application from
+ * having separate EventBus instances for each component, or using separate instances to separate
+ * events by context or topic. This also makes it trivial to set up and tear down EventBus objects
+ * in your tests.
+ *
+ * Of course, if you'd like to have a process-wide EventBus singleton, there's nothing stopping
+ * you from doing it that way. Simply have your container (such as Guice) create the EventBus as a
+ * singleton at global scope (or stash it in a static field, if you're into that sort of thing).
+ *
+ * In short, the EventBus is not a singleton because we'd rather not make that decision for you.
+ * Use it how you like.
+ *
+ * We feel that the Event Bus's {@code @Subscribe} annotation conveys your intentions just as
+ * explicitly as implementing an interface (or perhaps more so), while leaving you free to place
+ * event subscriber methods wherever you wish and give them intention-revealing names.
+ *
+ * Traditional Java Events use a listener interface which typically sports only a handful of
+ * methods -- typically one. This has a number of disadvantages:
+ *
+ * The difficulties in implementing this cleanly has given rise to a pattern, particularly common
+ * in Swing apps, of using tiny anonymous classes to implement event listener interfaces.
+ *
+ * Compare these two cases:
+ *
+ * The intent is actually clearer in the second case: there's less noise code, and the event
+ * subscriber has a clear and meaningful name.
+ *
+ * Some have proposed a generic {@code Subscriber Let's say the interface looked something like the following:
+ *
+ * Due to erasure, no single class can implement a generic interface more than once with
+ * different type parameters. This is a giant step backwards from traditional Java Events, where
+ * even if {@code actionPerformed} and {@code keyPressed} aren't very meaningful names, at least you
+ * can implement both methods!
+ *
+ * Some have freaked out about EventBus's {@code register(Object)} and {@code post(Object)}
+ * methods' use of the {@code Object} type.
+ *
+ * {@code Object} is used here for a good reason: the Event Bus library places no restrictions on
+ * the types of either your event listeners (as in {@code register(Object)}) or the events
+ * themselves (in {@code post(Object)}).
+ *
+ * Event subscriber methods, on the other hand, must explicitly declare their argument type --
+ * the type of event desired (or one of its supertypes). Thus, searching for references to an event
+ * class will instantly find all subscriber methods for that event, and renaming the type will
+ * affect all subscriber methods within view of your IDE (and any code that creates the event).
+ *
+ * It's true that you can rename your {@code @Subscribed} event subscriber methods at will; Event
+ * Bus will not stop this or do anything to propagate the rename because, to Event Bus, the names of
+ * your subscriber methods are irrelevant. Test code that calls the methods directly, of course,
+ * will be affected by your renaming -- but that's what your refactoring tools are for.
+ *
+ * Nothing at all.
+ *
+ * The Event Bus was designed to integrate with containers and module systems, with Guice as the
+ * prototypical example. In these cases, it's convenient to have the container/factory/environment
+ * pass every created object to an EventBus's {@code register(Object)} method.
+ *
+ * This way, any object created by the container/factory/environment can hook into the system's
+ * event model simply by exposing subscriber methods.
+ *
+ * Any problem that can be unambiguously detected by Java's type system. For example, defining a
+ * subscriber method for a nonexistent event type.
+ *
+ * Immediately upon invoking {@code register(Object)}, the listener being registered is checked
+ * for the well-formedness of its subscriber methods. Specifically, any methods marked with
+ * {@code @Subscribe} must take only a single argument.
+ *
+ * Any violations of this rule will cause an {@code IllegalArgumentException} to be thrown.
+ *
+ * (This check could be moved to compile-time using APT, a solution we're researching.)
+ *
+ * If a component posts events with no registered listeners, it may indicate an error
+ * (typically an indication that you missed a {@code @Subscribe} annotation, or that the listening
+ * component is not loaded).
+ *
+ * (Note that this is not necessarily indicative of a problem. There are many cases where
+ * an application will deliberately ignore a posted event, particularly if the event is coming from
+ * code you don't control.)
+ *
+ * To handle such events, register a subscriber method for the {@code DeadEvent} class. Whenever
+ * EventBus receives an event with no registered subscribers, it will turn it into a {@code
+ * DeadEvent} and pass it your way -- allowing you to log it or otherwise recover.
+ *
+ * Because subscriber methods on your listener classes are normal methods, you can simply call
+ * them from your test code to simulate the EventBus.
+ */
+package org.openstreetmap.josm.eventbus;
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/MapFrameInitializedEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/MapFrameInitializedEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/MapFrameInitializedEvent.java (revision 34000)
@@ -0,0 +1,43 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui;
+
+import java.util.EventObject;
+
+/**
+ * Event fired when the map frame is initialized (after the first data is loaded).
+ */
+public class MapFrameInitializedEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ private final MapFrame oldFrame;
+ private final MapFrame newFrame;
+
+ /**
+ * Constructs a new {@code MapFrameInitializedEvent}.
+ * @param source object on which the Event initially occurred
+ * @param oldFrame The old MapFrame
+ * @param newFrame The new MapFrame
+ */
+ public MapFrameInitializedEvent(Object source, MapFrame oldFrame, MapFrame newFrame) {
+ super(source);
+ this.oldFrame = oldFrame;
+ this.newFrame = newFrame;
+ }
+
+ /**
+ * Returns the old MapFrame.
+ * @return the old MapFrame
+ */
+ public MapFrame getOldMapFrame() {
+ return oldFrame;
+ }
+
+ /**
+ * Returns the new MapFrame.
+ * @return the new MapFrame
+ */
+ public MapFrame getNewMapFrame() {
+ return newFrame;
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/MapModeChangeEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/MapModeChangeEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/MapModeChangeEvent.java (revision 34000)
@@ -0,0 +1,45 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui;
+
+import java.util.EventObject;
+
+import org.openstreetmap.josm.actions.mapmode.MapMode;
+
+/**
+ * Event fired when the map mode changes.
+ */
+public class MapModeChangeEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ private final MapMode oldMapMode;
+ private final MapMode newMapMode;
+
+ /**
+ * Constructs a new {@code MapModeChangeEvent}.
+ * @param source object on which the Event initially occurred
+ * @param oldMapMode old map mode
+ * @param newMapMode new map mode
+ */
+ public MapModeChangeEvent(Object source, MapMode oldMapMode, MapMode newMapMode) {
+ super(source);
+ this.oldMapMode = oldMapMode;
+ this.newMapMode = newMapMode;
+ }
+
+ /**
+ * Returns the old map mode.
+ * @return the old map mode
+ */
+ public final MapMode getOldMapMode() {
+ return oldMapMode;
+ }
+
+ /**
+ * Returns the new map mode.
+ * @return the new map mode
+ */
+ public final MapMode getNewMapMode() {
+ return newMapMode;
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/ZoomChangedEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/ZoomChangedEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/ZoomChangedEvent.java (revision 34000)
@@ -0,0 +1,20 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui;
+
+import java.util.EventObject;
+
+/**
+ * Event fired when the zoom changes.
+ */
+public class ZoomChangedEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * Constructs a new {@code ZoomChangedEvent}.
+ * @param source object on which the Event initially occurred
+ */
+ public ZoomChangedEvent(Object source) {
+ super(source);
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/conflict/tags/NextDecisionEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/conflict/tags/NextDecisionEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/conflict/tags/NextDecisionEvent.java (revision 34000)
@@ -0,0 +1,20 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.conflict.tags;
+
+import java.util.EventObject;
+
+/**
+ * Event fired when the focus goes to next decision.
+ */
+public class NextDecisionEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * Constructs a new {@code NextDecisionEvent}.
+ * @param source object on which the Event initially occurred
+ */
+ public NextDecisionEvent(Object source) {
+ super(source);
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/conflict/tags/PreviousDecisionEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/conflict/tags/PreviousDecisionEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/conflict/tags/PreviousDecisionEvent.java (revision 34000)
@@ -0,0 +1,20 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.conflict.tags;
+
+import java.util.EventObject;
+
+/**
+ * Event fired when the focus goes to previous decision.
+ */
+public class PreviousDecisionEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * Constructs a new {@code PreviousDecisionEvent}.
+ * @param source object on which the Event initially occurred
+ */
+ public PreviousDecisionEvent(Object source) {
+ super(source);
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/dialogs/LayerListRefreshedEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/dialogs/LayerListRefreshedEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/dialogs/LayerListRefreshedEvent.java (revision 34000)
@@ -0,0 +1,20 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.dialogs;
+
+import java.util.EventObject;
+
+/**
+ * Event fired when the list of layers is refreshed.
+ */
+public class LayerListRefreshedEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * Constructs a new {@code LayerListRefreshedEvent}.
+ * @param source object on which the Event initially occurred
+ */
+ public LayerListRefreshedEvent(Object source) {
+ super(source);
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/dialogs/LayerVisibleEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/dialogs/LayerVisibleEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/dialogs/LayerVisibleEvent.java (revision 34000)
@@ -0,0 +1,46 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.dialogs;
+
+import java.util.EventObject;
+import java.util.Objects;
+
+import org.openstreetmap.josm.gui.layer.Layer;
+
+/**
+ * Event fired when a layer becomes visible.
+ */
+public class LayerVisibleEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ private final int index;
+ private final Layer layer;
+
+ /**
+ * Constructs a new {@code LayerVisibleEvent}.
+ * @param source object on which the Event initially occurred
+ * @param index layer index
+ * @param layer layer
+ */
+ public LayerVisibleEvent(Object source, int index, Layer layer) {
+ super(source);
+ this.index = index;
+ this.layer = Objects.requireNonNull(layer);
+ }
+
+ /**
+ * Returns the layer index.
+ * @return the layer index
+ */
+ public final int getIndex() {
+ return index;
+ }
+
+ /**
+ * Returns the layer.
+ * @return the layer
+ */
+ public final Layer getLayer() {
+ return layer;
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/dialogs/relation/MemberVisibleEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/dialogs/relation/MemberVisibleEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/dialogs/relation/MemberVisibleEvent.java (revision 34000)
@@ -0,0 +1,32 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.dialogs.relation;
+
+import java.util.EventObject;
+
+/**
+ * Event fired when a relation member becomes visible in the relation dialog.
+ */
+public class MemberVisibleEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ private final int index;
+
+ /**
+ * Constructs a new {@code MemberVisibleEvent}.
+ * @param source object on which the Event initially occurred
+ * @param index index of the member in the table
+ */
+ public MemberVisibleEvent(Object source, int index) {
+ super(source);
+ this.index = index;
+ }
+
+ /**
+ * Returns member index in member table.
+ * @return member index in member table
+ */
+ public final int getIndex() {
+ return index;
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/download/DownloadSourceAddedEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/download/DownloadSourceAddedEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/download/DownloadSourceAddedEvent.java (revision 34000)
@@ -0,0 +1,33 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.download;
+
+import java.util.EventObject;
+import java.util.Objects;
+
+/**
+ * Event fired when a download source is added.
+ */
+public class DownloadSourceAddedEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ private final DownloadSource downloadSource;
+
+ /**
+ * Constructs a new {@code DownloadSourceAddedEvent}.
+ * @param source object on which the Event initially occurred
+ * @param downloadSource new download source
+ */
+ public DownloadSourceAddedEvent(Object source, DownloadSource downloadSource) {
+ super(source);
+ this.downloadSource = Objects.requireNonNull(downloadSource);
+ }
+
+ /**
+ * Returns the added download source.
+ * @return the added download source
+ */
+ public DownloadSource getDownloadSource() {
+ return downloadSource;
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/layer/LayerStateChangeEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/layer/LayerStateChangeEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/layer/LayerStateChangeEvent.java (revision 34000)
@@ -0,0 +1,44 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.layer;
+
+import java.util.EventObject;
+import java.util.Objects;
+
+/**
+ * Event fired when the "upload discouraged" (upload=no) state changes.
+ */
+public class LayerStateChangeEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ private final OsmDataLayer osmDataLayer;
+ private final boolean newValue;
+
+ /**
+ * Constructs a new {@code LayerStateChangeEvent}.
+ * @param source object on which the Event initially occurred
+ * @param layer data layer
+ * @param newValue new value of the "upload discouraged" (upload=no) state
+ */
+ public LayerStateChangeEvent(Object source, OsmDataLayer layer, boolean newValue) {
+ super(source);
+ this.osmDataLayer = Objects.requireNonNull(layer);
+ this.newValue = newValue;
+ }
+
+ /**
+ * Returns the data layer.
+ * @return the data layer
+ */
+ public final OsmDataLayer getDataLayer() {
+ return osmDataLayer;
+ }
+
+ /**
+ * Returns the "upload discouraged" (upload=no) state.
+ * @return the "upload discouraged" (upload=no) state
+ */
+ public final boolean isUploadDiscouraged() {
+ return newValue;
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/layer/imagery/FilterChangedEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/layer/imagery/FilterChangedEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/layer/imagery/FilterChangedEvent.java (revision 34000)
@@ -0,0 +1,20 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.layer.imagery;
+
+import java.util.EventObject;
+
+/**
+ * Event fired when imagery filters settings change.
+ */
+public class FilterChangedEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * Constructs a new {@code FilterChangedEvent}.
+ * @param source object on which the Event initially occurred
+ */
+ public FilterChangedEvent(Object source) {
+ super(source);
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/mappaint/MapPaintStyleEntryUpdatedEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/mappaint/MapPaintStyleEntryUpdatedEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/mappaint/MapPaintStyleEntryUpdatedEvent.java (revision 34000)
@@ -0,0 +1,32 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.mappaint;
+
+import java.util.EventObject;
+
+/**
+ * Event fired when a map paint style entry is updated.
+ */
+public class MapPaintStyleEntryUpdatedEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ private final int index;
+
+ /**
+ * Constructs a new {@code MapPaintStyleEntryUpdatedEvent}.
+ * @param source object on which the Event initially occurred
+ * @param index entry index
+ */
+ public MapPaintStyleEntryUpdatedEvent(Object source, int index) {
+ super(source);
+ this.index = index;
+ }
+
+ /**
+ * Returns entry index.
+ * @return entry index
+ */
+ public final int getIndex() {
+ return index;
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/mappaint/MapPaintStylesUpdatedEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/mappaint/MapPaintStylesUpdatedEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/mappaint/MapPaintStylesUpdatedEvent.java (revision 34000)
@@ -0,0 +1,20 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.mappaint;
+
+import java.util.EventObject;
+
+/**
+ * Event fired when map paint styles are updated.
+ */
+public class MapPaintStylesUpdatedEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * Constructs a new {@code MapPaintStylesUpdatedEvent}.
+ * @param source object on which the Event initially occurred
+ */
+ public MapPaintStylesUpdatedEvent(Object source) {
+ super(source);
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/preferences/imagery/ContentValidationEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/preferences/imagery/ContentValidationEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/preferences/imagery/ContentValidationEvent.java (revision 34000)
@@ -0,0 +1,32 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.preferences.imagery;
+
+import java.util.EventObject;
+
+/**
+ * Event fired when the validation status of the "add imagery" panel changes.
+ */
+public class ContentValidationEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ private final boolean isValid;
+
+ /**
+ * Constructs a new {@code ContentValidationEvent}.
+ * @param source object on which the Event initially occurred
+ * @param isValid true if the conditions required to close this panel are met
+ */
+ public ContentValidationEvent(Object source, boolean isValid) {
+ super(source);
+ this.isValid = isValid;
+ }
+
+ /**
+ * Determines if the conditions required to close this panel are met.
+ * @return true if the conditions required to close this panel are met
+ */
+ public final boolean isValid() {
+ return isValid;
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/preferences/server/ProxyPreferenceChangedEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/preferences/server/ProxyPreferenceChangedEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/preferences/server/ProxyPreferenceChangedEvent.java (revision 34000)
@@ -0,0 +1,20 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.preferences.server;
+
+import java.util.EventObject;
+
+/**
+ * Event fired when proxy settings are updated.
+ */
+public class ProxyPreferenceChangedEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * Constructs a new {@code ProxyPreferenceChangedEvent}.
+ * @param source object on which the Event initially occurred
+ */
+ public ProxyPreferenceChangedEvent(Object source) {
+ super(source);
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/progress/OperationCancelledEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/progress/OperationCancelledEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/progress/OperationCancelledEvent.java (revision 34000)
@@ -0,0 +1,20 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.progress;
+
+import java.util.EventObject;
+
+/**
+ * Event fired when a task is cancelled.
+ */
+public class OperationCancelledEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * Constructs a new {@code OperationCancelledEvent}.
+ * @param source object on which the Event initially occurred
+ */
+ public OperationCancelledEvent(Object source) {
+ super(source);
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/tagging/presets/TaggingPresetModifiedEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/tagging/presets/TaggingPresetModifiedEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/tagging/presets/TaggingPresetModifiedEvent.java (revision 34000)
@@ -0,0 +1,20 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.tagging.presets;
+
+import java.util.EventObject;
+
+/**
+ * Event fired when a tagging preset is modified.
+ */
+public class TaggingPresetModifiedEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * Constructs a new {@code TaggingPresetModifiedEvent}.
+ * @param source object on which the Event initially occurred
+ */
+ public TaggingPresetModifiedEvent(Object source) {
+ super(source);
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/util/KeyPressedEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/util/KeyPressedEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/util/KeyPressedEvent.java (revision 34000)
@@ -0,0 +1,33 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.util;
+
+import java.awt.event.KeyEvent;
+import java.util.EventObject;
+
+/**
+ * Event fired when a key is pressed.
+ */
+public class KeyPressedEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ private final KeyEvent keyEvent;
+
+ /**
+ * Constructs a new {@code KeyPressedEvent}.
+ * @param source object on which the Event initially occurred
+ * @param keyEvent the original Swing key event
+ */
+ public KeyPressedEvent(Object source, KeyEvent keyEvent) {
+ super(source);
+ this.keyEvent = keyEvent;
+ }
+
+ /**
+ * Returns the original Swing key event.
+ * @return the original Swing key event
+ */
+ public final KeyEvent getKeyEvent() {
+ return keyEvent;
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/util/KeyReleasedEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/util/KeyReleasedEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/util/KeyReleasedEvent.java (revision 34000)
@@ -0,0 +1,33 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.util;
+
+import java.awt.event.KeyEvent;
+import java.util.EventObject;
+
+/**
+ * Event fired when a key is released.
+ */
+public class KeyReleasedEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ private final KeyEvent keyEvent;
+
+ /**
+ * Constructs a new {@code KeyReleasedEvent}.
+ * @param source object on which the Event initially occurred
+ * @param keyEvent the original Swing key event
+ */
+ public KeyReleasedEvent(Object source, KeyEvent keyEvent) {
+ super(source);
+ this.keyEvent = keyEvent;
+ }
+
+ /**
+ * Returns the original Swing key event.
+ * @return the original Swing key event
+ */
+ public final KeyEvent getKeyEvent() {
+ return keyEvent;
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/util/ModifierExChangedEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/util/ModifierExChangedEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/gui/util/ModifierExChangedEvent.java (revision 34000)
@@ -0,0 +1,32 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.util;
+
+import java.util.EventObject;
+
+/**
+ * Event fired when pressed extended modifier keys change is detected.
+ */
+public class ModifierExChangedEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ private final int modifiers;
+
+ /**
+ * Constructs a new {@code ModifierExChangedEvent}.
+ * @param source object on which the Event initially occurred
+ * @param modifiers the new extended modifiers
+ */
+ public ModifierExChangedEvent(Object source, int modifiers) {
+ super(source);
+ this.modifiers = modifiers;
+ }
+
+ /**
+ * Returns the new extended modifiers.
+ * @return the new extended modifiers
+ */
+ public final int getModifiers() {
+ return modifiers;
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/io/OsmApiInitializedEvent.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/io/OsmApiInitializedEvent.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/io/OsmApiInitializedEvent.java (revision 34000)
@@ -0,0 +1,32 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.io;
+
+import java.util.EventObject;
+
+/**
+ * Event fired when the OSM API is initialized.
+ */
+public class OsmApiInitializedEvent extends EventObject {
+
+ private static final long serialVersionUID = 1L;
+
+ private final OsmApi osmApi;
+
+ /**
+ * Constructs a new {@code OsmApiInitializedEvent}.
+ * @param source object on which the Event initially occurred
+ * @param osmApi OSM API
+ */
+ public OsmApiInitializedEvent(Object source, OsmApi osmApi) {
+ super(source);
+ this.osmApi = osmApi;
+ }
+
+ /**
+ * Returns the OSM API.
+ * @return the OSM API
+ */
+ public final OsmApi getOsmApi() {
+ return osmApi;
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/plugins/eventbus/EventBusPlugin.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/plugins/eventbus/EventBusPlugin.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/src/org/openstreetmap/josm/plugins/eventbus/EventBusPlugin.java (revision 34000)
@@ -0,0 +1,435 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.plugins.eventbus;
+
+import static org.openstreetmap.josm.eventbus.JosmEventBus.post;
+
+import java.awt.event.KeyEvent;
+
+import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.actions.ExpertModeChangedEvent;
+import org.openstreetmap.josm.actions.ExpertToggleAction;
+import org.openstreetmap.josm.actions.ExpertToggleAction.ExpertModeChangeListener;
+import org.openstreetmap.josm.data.CommandQueueEvent;
+import org.openstreetmap.josm.data.SelectionChangedListener;
+import org.openstreetmap.josm.data.SoMChangedEvent;
+import org.openstreetmap.josm.data.SystemOfMeasurement;
+import org.openstreetmap.josm.data.SystemOfMeasurement.SoMChangeListener;
+import org.openstreetmap.josm.data.UndoRedoHandler.CommandQueueListener;
+import org.openstreetmap.josm.data.conflict.ConflictCollection;
+import org.openstreetmap.josm.data.conflict.ConflictsAddedEvent;
+import org.openstreetmap.josm.data.conflict.ConflictsRemovedEvent;
+import org.openstreetmap.josm.data.conflict.IConflictListener;
+import org.openstreetmap.josm.data.gpx.GpxData;
+import org.openstreetmap.josm.data.gpx.GpxData.GpxDataChangeListener;
+import org.openstreetmap.josm.data.gpx.GpxTrack.GpxTrackChangeListener;
+import org.openstreetmap.josm.data.osm.ChangesetCache;
+import org.openstreetmap.josm.data.osm.ChangesetCacheListener;
+import org.openstreetmap.josm.data.osm.DataSelectionListener;
+import org.openstreetmap.josm.data.osm.DataSet;
+import org.openstreetmap.josm.data.osm.HighlightUpdateListener;
+import org.openstreetmap.josm.data.osm.NoteData;
+import org.openstreetmap.josm.data.osm.NoteData.NoteDataUpdateListener;
+import org.openstreetmap.josm.data.osm.NoteDataUpdatedEvent;
+import org.openstreetmap.josm.data.osm.PrimitiveId;
+import org.openstreetmap.josm.data.osm.SelectedNoteChangedEvent;
+import org.openstreetmap.josm.data.osm.event.AbstractDatasetChangedEvent;
+import org.openstreetmap.josm.data.osm.event.DataChangedEvent;
+import org.openstreetmap.josm.data.osm.event.DataSetListener;
+import org.openstreetmap.josm.data.osm.event.NodeMovedEvent;
+import org.openstreetmap.josm.data.osm.event.PrimitivesAddedEvent;
+import org.openstreetmap.josm.data.osm.event.PrimitivesRemovedEvent;
+import org.openstreetmap.josm.data.osm.event.RelationMembersChangedEvent;
+import org.openstreetmap.josm.data.osm.event.TagsChangedEvent;
+import org.openstreetmap.josm.data.osm.event.WayNodesChangedEvent;
+import org.openstreetmap.josm.data.osm.history.HistoryClearedEvent;
+import org.openstreetmap.josm.data.osm.history.HistoryDataSet;
+import org.openstreetmap.josm.data.osm.history.HistoryDataSetListener;
+import org.openstreetmap.josm.data.osm.history.HistoryUpdatedEvent;
+import org.openstreetmap.josm.data.projection.ProjectionChangeListener;
+import org.openstreetmap.josm.data.projection.ProjectionChangedEvent;
+import org.openstreetmap.josm.gui.MainApplication;
+import org.openstreetmap.josm.gui.MapFrame;
+import org.openstreetmap.josm.gui.MapFrame.MapModeChangeListener;
+import org.openstreetmap.josm.gui.MapFrameInitializedEvent;
+import org.openstreetmap.josm.gui.MapModeChangeEvent;
+import org.openstreetmap.josm.gui.NavigatableComponent;
+import org.openstreetmap.josm.gui.NavigatableComponent.ZoomChangeListener;
+import org.openstreetmap.josm.gui.ZoomChangedEvent;
+import org.openstreetmap.josm.gui.conflict.tags.MultiValueCellEditor.NavigationListener;
+import org.openstreetmap.josm.gui.conflict.tags.NextDecisionEvent;
+import org.openstreetmap.josm.gui.conflict.tags.PreviousDecisionEvent;
+import org.openstreetmap.josm.gui.dialogs.LayerListDialog;
+import org.openstreetmap.josm.gui.dialogs.LayerListDialog.LayerListModelListener;
+import org.openstreetmap.josm.gui.dialogs.LayerListRefreshedEvent;
+import org.openstreetmap.josm.gui.dialogs.LayerVisibleEvent;
+import org.openstreetmap.josm.gui.dialogs.relation.IMemberModelListener;
+import org.openstreetmap.josm.gui.dialogs.relation.MemberVisibleEvent;
+import org.openstreetmap.josm.gui.layer.AbstractTileSourceLayer;
+import org.openstreetmap.josm.gui.layer.GpxLayer;
+import org.openstreetmap.josm.gui.layer.ImageryLayer;
+import org.openstreetmap.josm.gui.layer.Layer;
+import org.openstreetmap.josm.gui.layer.LayerManager.LayerAddEvent;
+import org.openstreetmap.josm.gui.layer.LayerManager.LayerChangeListener;
+import org.openstreetmap.josm.gui.layer.LayerManager.LayerOrderChangeEvent;
+import org.openstreetmap.josm.gui.layer.LayerManager.LayerRemoveEvent;
+import org.openstreetmap.josm.gui.layer.LayerStateChangeEvent;
+import org.openstreetmap.josm.gui.layer.MainLayerManager.ActiveLayerChangeListener;
+import org.openstreetmap.josm.gui.layer.MainLayerManager.LayerAvailabilityEvent;
+import org.openstreetmap.josm.gui.layer.MainLayerManager.LayerAvailabilityListener;
+import org.openstreetmap.josm.gui.layer.MapViewPaintable.PaintableInvalidationListener;
+import org.openstreetmap.josm.gui.layer.NoteLayer;
+import org.openstreetmap.josm.gui.layer.OsmDataLayer;
+import org.openstreetmap.josm.gui.layer.OsmDataLayer.LayerStateChangeListener;
+import org.openstreetmap.josm.gui.layer.imagery.FilterChangedEvent;
+import org.openstreetmap.josm.gui.layer.imagery.ImageryFilterSettings.FilterChangeListener;
+import org.openstreetmap.josm.gui.layer.imagery.TileSourceDisplaySettings.DisplaySettingsChangeListener;
+import org.openstreetmap.josm.gui.mappaint.MapPaintStyleEntryUpdatedEvent;
+import org.openstreetmap.josm.gui.mappaint.MapPaintStyles;
+import org.openstreetmap.josm.gui.mappaint.MapPaintStyles.MapPaintSylesUpdateListener;
+import org.openstreetmap.josm.gui.mappaint.MapPaintStylesUpdatedEvent;
+import org.openstreetmap.josm.gui.preferences.imagery.AddImageryPanel.ContentValidationListener;
+import org.openstreetmap.josm.gui.preferences.imagery.ContentValidationEvent;
+import org.openstreetmap.josm.gui.preferences.server.ProxyPreference;
+import org.openstreetmap.josm.gui.preferences.server.ProxyPreferenceChangedEvent;
+import org.openstreetmap.josm.gui.preferences.server.ProxyPreferenceListener;
+import org.openstreetmap.josm.gui.progress.OperationCancelledEvent;
+import org.openstreetmap.josm.gui.progress.ProgressMonitor.CancelListener;
+import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetListener;
+import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetModifiedEvent;
+import org.openstreetmap.josm.gui.tagging.presets.TaggingPresets;
+import org.openstreetmap.josm.gui.util.KeyPressReleaseListener;
+import org.openstreetmap.josm.gui.util.KeyPressedEvent;
+import org.openstreetmap.josm.gui.util.KeyReleasedEvent;
+import org.openstreetmap.josm.gui.util.ModifierExChangedEvent;
+import org.openstreetmap.josm.gui.util.ModifierExListener;
+import org.openstreetmap.josm.io.OsmApi;
+import org.openstreetmap.josm.io.OsmApi.OsmApiInitializationListener;
+import org.openstreetmap.josm.io.OsmApiInitializedEvent;
+import org.openstreetmap.josm.plugins.Plugin;
+import org.openstreetmap.josm.plugins.PluginInformation;
+import org.openstreetmap.josm.spi.preferences.Config;
+import org.openstreetmap.josm.spi.preferences.PreferenceChangedListener;
+import org.openstreetmap.josm.tools.Logging;
+
+/**
+ * Event bus plugin, providing an event bus more powerful than the traditional listeners registration.
+ */
+public class EventBusPlugin extends Plugin {
+
+ // Defines an instance for each type of listener, and keeps a reference to avoid garbage collection
+
+ private final ActiveLayerChangeListener activeLayerChangeListener = e -> post(e);
+ private final ChangesetCacheListener changesetCacheListener = e -> post(e);
+ private final DataSelectionListener selectionListener = e -> post(e);
+ private final ExpertModeChangeListener expertModeChangeListener = x -> post(new ExpertModeChangedEvent(this, x));
+ private final GpxDataChangeListener gpxChangeListener = e -> post(e);
+ private final GpxTrackChangeListener gpxTrackChangeListener = e -> post(e);
+ private final HighlightUpdateListener highlightUpdateListener = e -> post(e);
+ private final SelectionChangedListener selectionChangedListener = e -> post(e);
+ private final PreferenceChangedListener preferenceChangedListener = e -> post(e);
+ private final PaintableInvalidationListener paintableInvalidationListener = e -> post(e);
+ private final NoteDataUpdateListener noteDataUpdateListener = new NoteDataUpdateListener() {
+ @Override
+ public void selectedNoteChanged(NoteData noteData) {
+ post(new SelectedNoteChangedEvent(this, noteData));
+ }
+
+ @Override
+ public void noteDataUpdated(NoteData data) {
+ post(new NoteDataUpdatedEvent(this, data));
+ }
+ };
+
+ private final IConflictListener conflictsListener = new IConflictListener() {
+ @Override
+ public void onConflictsRemoved(ConflictCollection conflicts) {
+ post(new ConflictsRemovedEvent(this, conflicts));
+ }
+
+ @Override
+ public void onConflictsAdded(ConflictCollection conflicts) {
+ post(new ConflictsAddedEvent(this, conflicts));
+ }
+ };
+
+ private final FilterChangeListener filterChangeListener = () -> post(new FilterChangedEvent(this));
+ private final DisplaySettingsChangeListener displaySettingsChangeListener = e -> post(e);
+
+ private final LayerStateChangeListener layerStateChangeListener =
+ (layer, newValue) -> post(new LayerStateChangeEvent(this, layer, newValue));
+
+ private final LayerAvailabilityListener layerAvailabilityListener = new LayerAvailabilityListener() {
+ @Override
+ public void beforeFirstLayerAdded(LayerAvailabilityEvent e) {
+ post(e);
+ }
+
+ @Override
+ public void afterLastLayerRemoved(LayerAvailabilityEvent e) {
+ post(e);
+ }
+ };
+
+ // CHECKSTYLE.OFF: AnonInnerLengthCheck
+ private final LayerChangeListener layerChangeListener = new LayerChangeListener() {
+ @Override
+ public void layerAdded(LayerAddEvent e) {
+ post(e);
+ Layer layer = e.getAddedLayer();
+ layer.addInvalidationListener(paintableInvalidationListener);
+ if (layer instanceof OsmDataLayer) {
+ ((OsmDataLayer) layer).addLayerStateChangeListener(layerStateChangeListener);
+ DataSet ds = ((OsmDataLayer) layer).data;
+ ds.addDataSetListener(dataSetListener);
+ ds.addHighlightUpdateListener(highlightUpdateListener);
+ ds.addSelectionListener(selectionListener);
+ ds.getConflicts().addConflictListener(conflictsListener);
+ } else if (layer instanceof GpxLayer) {
+ GpxData gpx = ((GpxLayer) layer).data;
+ gpx.addChangeListener(gpxChangeListener);
+ // TODO: cannot add a listener for GpxTrackChangeListener. It would require first new events for tracks being added and removed
+ Logging.debug("TODO: add" + gpxTrackChangeListener);
+ } else if (layer instanceof NoteLayer) {
+ NoteData notes = ((NoteLayer) layer).getNoteData();
+ notes.addNoteDataUpdateListener(noteDataUpdateListener);
+ } else if (layer instanceof ImageryLayer) {
+ ((ImageryLayer) layer).getFilterSettings().addFilterChangeListener(filterChangeListener);
+ if (layer instanceof AbstractTileSourceLayer) {
+ ((AbstractTileSourceLayer) layer).getDisplaySettings().addSettingsChangeListener(displaySettingsChangeListener);
+ }
+ }
+ }
+
+ @Override
+ public void layerRemoving(LayerRemoveEvent e) {
+ post(e);
+ Layer layer = e.getRemovedLayer();
+ layer.removeInvalidationListener(paintableInvalidationListener);
+ if (layer instanceof OsmDataLayer) {
+ ((OsmDataLayer) layer).removeLayerStateChangeListener(layerStateChangeListener);
+ DataSet ds = ((OsmDataLayer) layer).data;
+ ds.removeDataSetListener(dataSetListener);
+ ds.removeHighlightUpdateListener(highlightUpdateListener);
+ ds.removeSelectionListener(selectionListener);
+ ds.getConflicts().removeConflictListener(conflictsListener);
+ // TODO: cannot add a listener for GpxTrackChangeListener. It would require first new events for tracks being added and removed
+ Logging.debug("TODO: remove" + gpxTrackChangeListener);
+ } else if (layer instanceof GpxLayer) {
+ GpxData gpx = ((GpxLayer) layer).data;
+ gpx.removeChangeListener(gpxChangeListener);
+ } else if (layer instanceof NoteLayer) {
+ NoteData notes = ((NoteLayer) layer).getNoteData();
+ notes.removeNoteDataUpdateListener(noteDataUpdateListener);
+ } else if (layer instanceof ImageryLayer) {
+ ((ImageryLayer) layer).getFilterSettings().removeFilterChangeListener(filterChangeListener);
+ if (layer instanceof AbstractTileSourceLayer) {
+ ((AbstractTileSourceLayer) layer).getDisplaySettings().removeSettingsChangeListener(displaySettingsChangeListener);
+ }
+ }
+ }
+
+ @Override
+ public void layerOrderChanged(LayerOrderChangeEvent e) {
+ post(e);
+ }
+ };
+ // CHECKSTYLE.ON: AnonInnerLengthCheck
+
+ private final DataSetListener dataSetListener = new DataSetListener() {
+ @Override
+ public void wayNodesChanged(WayNodesChangedEvent event) {
+ post(event);
+ }
+
+ @Override
+ public void tagsChanged(TagsChangedEvent event) {
+ post(event);
+ }
+
+ @Override
+ public void relationMembersChanged(RelationMembersChangedEvent event) {
+ post(event);
+ }
+
+ @Override
+ public void primitivesRemoved(PrimitivesRemovedEvent event) {
+ post(event);
+ }
+
+ @Override
+ public void primitivesAdded(PrimitivesAddedEvent event) {
+ post(event);
+ }
+
+ @Override
+ public void otherDatasetChange(AbstractDatasetChangedEvent event) {
+ post(event);
+ }
+
+ @Override
+ public void nodeMoved(NodeMovedEvent event) {
+ post(event);
+ }
+
+ @Override
+ public void dataChanged(DataChangedEvent event) {
+ post(event);
+ }
+ };
+
+ private final HistoryDataSetListener historyDataSetListener = new HistoryDataSetListener() {
+ @Override
+ public void historyUpdated(HistoryDataSet source, PrimitiveId id) {
+ post(new HistoryUpdatedEvent(this, source, id));
+ }
+
+ @Override
+ public void historyDataSetCleared(HistoryDataSet source) {
+ post(new HistoryClearedEvent(this, source));
+ }
+ };
+
+ private final ProjectionChangeListener projectionChangeListener = (oldValue, newValue) -> {
+ post(new ProjectionChangedEvent(this, oldValue, newValue));
+ };
+
+ private final SoMChangeListener soMChangeListener = (oldSoM, newSoM) -> {
+ post(new SoMChangedEvent(this, oldSoM, newSoM));
+ };
+
+ private final CommandQueueListener commandQueueListener = (queueSize, redoSize) -> {
+ post(new CommandQueueEvent(this, queueSize, redoSize));
+ };
+
+ private final NavigationListener navigationListener = new NavigationListener() {
+ @Override
+ public void gotoNextDecision() {
+ post(new NextDecisionEvent(this));
+ }
+
+ @Override
+ public void gotoPreviousDecision() {
+ post(new PreviousDecisionEvent(this));
+ }
+ };
+
+ private final LayerListModelListener layerListModelListener = new LayerListModelListener() {
+ @Override
+ public void makeVisible(int index, Layer layer) {
+ post(new LayerVisibleEvent(this, index, layer));
+ }
+
+ @Override
+ public void refresh() {
+ post(new LayerListRefreshedEvent(this));
+ }
+ };
+
+ private final IMemberModelListener memberModelListener = index -> post(new MemberVisibleEvent(this, index));
+ // private final DownloadSourceListener downloadSourceListener = source -> post(new DownloadSourceAddedEvent(source)); // TODO: not public
+ private final ContentValidationListener contentValidationListener = isValid -> post(new ContentValidationEvent(this, isValid));
+ private final ProxyPreferenceListener proxyPreferenceListener = () -> post(new ProxyPreferenceChangedEvent(this));
+ private final CancelListener cancelListener = () -> post(new OperationCancelledEvent(this));
+ private final TaggingPresetListener taggingPresetListener = () -> post(new TaggingPresetModifiedEvent(this));
+
+ private final MapPaintSylesUpdateListener mapPaintSylesUpdateListener = new MapPaintSylesUpdateListener() {
+ @Override
+ public void mapPaintStylesUpdated() {
+ post(new MapPaintStylesUpdatedEvent(this));
+ }
+
+ @Override
+ public void mapPaintStyleEntryUpdated(int index) {
+ post(new MapPaintStyleEntryUpdatedEvent(this, index));
+ }
+ };
+
+ private final OsmApiInitializationListener osmApiInitializationListener = api -> post(new OsmApiInitializedEvent(this, api));
+ //private final AudioListener audioListener = url -> post(new AudioPlayingEvent(url)); // TODO: not public
+ private final ZoomChangeListener zoomChangeListener = () -> post(new ZoomChangedEvent(this));
+ private final MapModeChangeListener mapModeChangeListener = (oldMode, newMode) -> post(new MapModeChangeEvent(this, oldMode, newMode));
+ private final ModifierExListener modifierExListener = modifiers -> post(new ModifierExChangedEvent(this, modifiers));
+ private final KeyPressReleaseListener keyPressReleaseListener = new KeyPressReleaseListener() {
+ @Override
+ public void doKeyPressed(KeyEvent e) {
+ post(new KeyPressedEvent(this, e));
+ }
+
+ @Override
+ public void doKeyReleased(KeyEvent e) {
+ post(new KeyReleasedEvent(this, e));
+ }
+ };
+
+ /**
+ * Constructs a new {@code EventBusPlugin}.
+ * @param info plugin information
+ */
+ public EventBusPlugin(PluginInformation info) {
+ super(info);
+ registerAllJosmListeners();
+ // TODO: cannot add a listener for NavigationListener. It would require first new events for MultiValueCellEditor being created
+ Logging.debug("TODO: add" + navigationListener);
+ // TODO: cannot add a listener for IMemberModelListener. It would require first new events for GenericRelationEditor being created
+ Logging.debug("TODO: add" + memberModelListener);
+ // TODO: cannot add a listener for ContentValidationListener. It would require first new events for AddImageryDialog being created
+ Logging.debug("TODO: add" + contentValidationListener);
+ // TODO: cannot add a listener for CancelListener. It would require first new events for ProgressMonitor being created
+ Logging.debug("TODO: add" + cancelListener);
+ }
+
+ void registerAllJosmListeners() {
+ Main.addProjectionChangeListener(projectionChangeListener);
+ MainApplication.getLayerManager().addLayerChangeListener(layerChangeListener);
+ MainApplication.getLayerManager().addActiveLayerChangeListener(activeLayerChangeListener);
+ MainApplication.getLayerManager().addLayerAvailabilityListener(layerAvailabilityListener);
+ MainApplication.undoRedo.addCommandQueueListener(commandQueueListener);
+ ChangesetCache.getInstance().addChangesetCacheListener(changesetCacheListener);
+ DataSet.addSelectionListener(selectionChangedListener);
+ ExpertToggleAction.addExpertModeChangeListener(expertModeChangeListener);
+ HistoryDataSet.getInstance().addHistoryDataSetListener(historyDataSetListener);
+ SystemOfMeasurement.addSoMChangeListener(soMChangeListener);
+ MapPaintStyles.addMapPaintSylesUpdateListener(mapPaintSylesUpdateListener);
+ ProxyPreference.addProxyPreferenceListener(proxyPreferenceListener);
+ MapFrame.addMapModeChangeListener(mapModeChangeListener);
+ NavigatableComponent.addZoomChangeListener(zoomChangeListener);
+ TaggingPresets.addListener(taggingPresetListener);
+ OsmApi.addOsmApiInitializationListener(osmApiInitializationListener);
+ Config.getPref().addPreferenceChangeListener(preferenceChangedListener);
+ }
+
+ void unregisterAllJosmListeners() {
+ Main.removeProjectionChangeListener(projectionChangeListener);
+ MainApplication.getLayerManager().removeLayerChangeListener(layerChangeListener);
+ MainApplication.getLayerManager().removeActiveLayerChangeListener(activeLayerChangeListener);
+ MainApplication.getLayerManager().removeLayerAvailabilityListener(layerAvailabilityListener);
+ MainApplication.undoRedo.removeCommandQueueListener(commandQueueListener);
+ ChangesetCache.getInstance().removeChangesetCacheListener(changesetCacheListener);
+ DataSet.removeSelectionListener(selectionChangedListener);
+ ExpertToggleAction.removeExpertModeChangeListener(expertModeChangeListener);
+ HistoryDataSet.getInstance().removeHistoryDataSetListener(historyDataSetListener);
+ SystemOfMeasurement.removeSoMChangeListener(soMChangeListener);
+ MapPaintStyles.removeMapPaintSylesUpdateListener(mapPaintSylesUpdateListener);
+ ProxyPreference.removeProxyPreferenceListener(proxyPreferenceListener);
+ MapFrame.removeMapModeChangeListener(mapModeChangeListener);
+ NavigatableComponent.removeZoomChangeListener(zoomChangeListener);
+ TaggingPresets.removeListener(taggingPresetListener);
+ OsmApi.removeOsmApiInitializationListener(osmApiInitializationListener);
+ Config.getPref().removePreferenceChangeListener(preferenceChangedListener);
+ }
+
+ @Override
+ public void mapFrameInitialized(MapFrame oldFrame, MapFrame newFrame) {
+ post(new MapFrameInitializedEvent(this, oldFrame, newFrame));
+ if (newFrame != null) {
+ newFrame.getToggleDialog(LayerListDialog.class).getModel().addLayerListModelListener(layerListModelListener);
+ newFrame.keyDetector.addKeyListener(keyPressReleaseListener);
+ newFrame.keyDetector.addModifierExListener(modifierExListener);
+ }
+ if (oldFrame != null) {
+ oldFrame.getToggleDialog(LayerListDialog.class).getModel().removeLayerListModelListener(layerListModelListener);
+ oldFrame.keyDetector.removeKeyListener(keyPressReleaseListener);
+ oldFrame.keyDetector.removeModifierExListener(modifierExListener);
+ }
+ }
+}
Index: /applications/editors/josm/plugins/eventbus/test/unit/org/openstreetmap/josm/eventbus/AsyncEventBusTest.java
===================================================================
--- /applications/editors/josm/plugins/eventbus/test/unit/org/openstreetmap/josm/eventbus/AsyncEventBusTest.java (revision 34000)
+++ /applications/editors/josm/plugins/eventbus/test/unit/org/openstreetmap/josm/eventbus/AsyncEventBusTest.java (revision 34000)
@@ -0,0 +1,88 @@
+/*
+ * Copyright (C) 2007 The Guava Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.openstreetmap.josm.eventbus;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.Executor;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.openstreetmap.josm.eventbus.AsyncEventBus;
+
+/**
+ * Test case for {@link AsyncEventBus}.
+ *
+ * @author Cliff Biffle
+ */
+public class AsyncEventBusTest {
+ private static final String EVENT = "Hello";
+
+ /** The executor we use to fake asynchronicity. */
+ private FakeExecutor executor;
+
+ private AsyncEventBus bus;
+
+ @Before
+ public void setUp() throws Exception {
+ executor = new FakeExecutor();
+ bus = new AsyncEventBus(executor);
+ }
+
+ @Test
+ public void testBasicDistribution() {
+ StringCatcher catcher = new StringCatcher();
+ bus.register(catcher);
+
+ // We post the event, but our Executor will not deliver it until instructed.
+ bus.post(EVENT);
+
+ ListReceiving Events
+ *
+ *
+ *
+ *
+ * Posting Events
+ *
+ * Subscriber Methods
+ *
+ * Dead Events
+ *
+ * One-Minute Guide
+ *
+ * For Listeners
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * For Producers
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * Glossary
+ *
+ *
+ *
+ *
+ * FAQ
+ *
+ * Why must I create my own Event Bus, rather than using a singleton?
+ *
+ * Why use an annotation to mark subscriber methods, rather than requiring the listener to
+ * implement an interface?
+ *
+ *
+ *
+ *
+ * {@code
+ * class ChangeRecorder {
+ * void setCustomer(Customer cust) {
+ * cust.addChangeListener(new ChangeListener() {
+ * void customerChanged(ChangeEvent e) {
+ * recordChange(e.getChange());
+ * }
+ * };
+ * }
+ * }
+ *
+ * // Class is typically registered by the container.
+ * class EventBusChangeRecorder {
+ * }{@code @Subscribe void recordCustomerChange(ChangeEvent e) {
+ * recordChange(e.getChange());
+ * }
+ * }
+ * }
+ *
+ * What about a generic {@code Subscriber
+ *
+ * {@code
+ * interface Subscriber
+ *
+ * Doesn't EventBus destroy static typing and eliminate automated refactoring support?
+ *
+ * What happens if I {@code register} a listener without any subscriber methods?
+ *
+ * What Event Bus problems can be detected at compile time?
+ *
+ * What Event Bus problems can be detected immediately at registration?
+ *
+ * What Event Bus problems may only be detected later, at runtime?
+ *
+ * How do I test event listeners and their subscriber methods?
+ *
+ *