+ * If an object is subscribed by proxy and it implements EventSubscriber, then the normal unsubscribe methods will
+ * still unsubscribe the object.
+ *
+ *
+ * @param eventClass class this object is subscribed to by proxy
+ * @param subscribedByProxy object subscribed by proxy
+ * @return true if the subscription was cancelled, false if it never existed
+ */
+ boolean unsubscribe(Class eventClass, Object subscribedByProxy);
+
+ /**
+ * Stop a subscription for an object that is subscribed exactly with a ProxySubscriber.
+ *
+ * If an object is subscribed by proxy and it implements EventSubscriber, then the normal unsubscribe methods will
+ * still unsubscribe the object.
+ *
+ *
+ * @param eventClass class this object is subscribed to by proxy
+ * @param subscribedByProxy object subscribed by proxy
+ * @return true if the subscription was cancelled, false if it never existed
+ */
+ boolean unsubscribeExactly(Class eventClass, Object subscribedByProxy);
+
+ /**
+ * Stop a subscription for an object that is subscribed to a topic with a ProxySubscriber.
+ *
+ * If an object is subscribed by proxy and it implements EventSubscriber, then the normal unsubscribe methods will
+ * still unsubscribe the object.
+ *
+ *
+ * @param topic the topic this object is subscribed to by proxy
+ * @param subscribedByProxy object subscribed by proxy
+ * @return true if the subscription was cancelled, false if it never existed
+ */
+ boolean unsubscribe(String topic, Object subscribedByProxy);
+
+ /**
+ * When using annotations, an object may be subscribed by proxy. This unsubscribe method will unsubscribe an object
+ * that is subscribed with a ProxySubscriber.
+ *
+ * If an object is subscribed by proxy and it implements EventSubscriber, then the normal unsubscribe methods will
+ * still unsubscribe the object.
+ *
+ *
+ * @param pattern the RegEx expression this object is subscribed to by proxy
+ * @param subscribedByProxy object subscribed by proxy
+ * @return true if the subscription was cancelled, false if it never existed
+ */
+ boolean unsubscribe(Pattern pattern, Object subscribedByProxy);
+
+ /**
+ * Stop a veto subscription for an object that is subscribed with a ProxySubscriber.
+ *
+ * If an object is subscribed by proxy and it implements VetoSubscriber, then the normal unsubscribe methods will
+ * still unsubscribe the object.
+ *
+ *
+ * @param eventClass class this object is subscribed to by proxy
+ * @param subscribedByProxy object subscribed by proxy
+ * @return true if the subscription was cancelled, false if it never existed
+ */
+ boolean unsubscribeVeto(Class eventClass, Object subscribedByProxy);
+
+ /**
+ * Stop a veto subscription for an object that is subscribed exactly with a ProxySubscriber.
+ *
+ * If an object is subscribed by proxy and it implements VetoSubscriber, then the normal unsubscribe methods will
+ * still unsubscribe the object.
+ *
+ *
+ * @param eventClass class this object is subscribed to by proxy
+ * @param subscribedByProxy object subscribed by proxy
+ * @return true if the subscription was cancelled, false if it never existed
+ */
+ boolean unsubscribeVetoExactly(Class eventClass, Object subscribedByProxy);
+
+ /**
+ * Stop a veto subscription for an object that is subscribed to a topic with a ProxySubscriber.
+ *
+ * If an object is subscribed by proxy and it implements EventSubscriber, then the normal unsubscribe methods will
+ * still unsubscribe the object.
+ *
+ *
+ * @param topic the topic this object is subscribed to by proxy
+ * @param subscribedByProxy object subscribed by proxy
+ * @return true if the subscription was cancelled, false if it never existed
+ */
+ boolean unsubscribeVeto(String topic, Object subscribedByProxy);
+
+ /**
+ * When using annotations, an object may be subscribed by proxy. This unsubscribe method will unsubscribe an object
+ * that is subscribed with a ProxySubscriber.
+ *
+ * If an object is subscribed by proxy and it implements EventSubscriber, then the normal unsubscribe methods will
+ * still unsubscribe the object.
+ *
+ *
+ * @param pattern the RegEx expression this object is subscribed to by proxy
+ * @param subscribedByProxy object subscribed by proxy
+ * @return true if the subscription was cancelled, false if it never existed
+ */
+ boolean unsubscribeVeto(Pattern pattern, Object subscribedByProxy);
+}
diff --git a/src/main/java/org/scijava/event/bushe/EventSubscriber.java b/src/main/java/org/scijava/event/bushe/EventSubscriber.java
new file mode 100644
index 000000000..03e8f9227
--- /dev/null
+++ b/src/main/java/org/scijava/event/bushe/EventSubscriber.java
@@ -0,0 +1,35 @@
+/**
+ * Copyright 2005 Bushe Enterprises, Inc., Hopkinton, MA, USA, www.bushe.com
+ *
+ * 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.scijava.event.bushe;
+
+/**
+ * Callback interface for class-based subscribers of an {@link EventService}.
+ *
+ * @author Michael Bushe michael@bushe.com
+ */
+public interface EventSubscriber {
+
+ /**
+ * Handle a published event. The EventService calls this method on each publication of an object that matches the
+ * class or interface passed to one of the EventService's class-based subscribe methods, specifically, {@link
+ * EventService#subscribe(Class,EventSubscriber)} {@link EventService#subscribeExactly(Class,EventSubscriber)}
+ * {@link EventService#subscribeStrongly(Class,EventSubscriber)} and {@link EventService#subscribeExactlyStrongly(Class,
+ *EventSubscriber)}.
+ *
+ * @param event The Object that is being published.
+ */
+ public void onEvent(T event);
+}
diff --git a/src/main/java/org/scijava/event/bushe/EventTopicSubscriber.java b/src/main/java/org/scijava/event/bushe/EventTopicSubscriber.java
new file mode 100644
index 000000000..37bf575e4
--- /dev/null
+++ b/src/main/java/org/scijava/event/bushe/EventTopicSubscriber.java
@@ -0,0 +1,39 @@
+/**
+ * Copyright 2005 Bushe Enterprises, Inc., Hopkinton, MA, USA, www.bushe.com
+ *
+ * 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.scijava.event.bushe;
+
+/**
+ * Callback interface for topic-based subscribers of an {@link EventService}.
+ *
+ * @author Michael Bushe michael@bushe.com
+ */
+interface EventTopicSubscriber {
+
+ /**
+ * Handle an event published on a topic.
+ *
+ * The EventService calls this method on each publication on a matching topic name passed to one of the
+ * EventService's topic-based subscribe methods, specifically, {@link EventService#subscribe(String,
+ *EventTopicSubscriber)} {@link EventService#subscribe(java.util.regex.Pattern,EventTopicSubscriber)} {@link
+ * EventService#subscribeStrongly(String,EventTopicSubscriber)} and {@link EventService#subscribeStrongly(java.util.regex.Pattern,
+ *EventTopicSubscriber)}.
+ *
+ *
+ * @param topic the name of the topic published on
+ * @param data the data object published on the topic
+ */
+ public void onEvent(String topic, T data);
+}
diff --git a/src/main/java/org/scijava/event/bushe/Logger.java b/src/main/java/org/scijava/event/bushe/Logger.java
new file mode 100644
index 000000000..f2de3981b
--- /dev/null
+++ b/src/main/java/org/scijava/event/bushe/Logger.java
@@ -0,0 +1,221 @@
+package org.scijava.event.bushe;
+
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.util.Map;
+import java.util.HashMap;
+
+/**
+ * Central Logging class. Shields code from Logging implementation.
+ *
+ * The EventBus allows operation in two modes - using java.util.logging so that
+ * the EventBus can be deployed in its own jar or using any logging system supported
+ * by apache commons logging, which of course requires other jars.
+ *
+ *
+ * The EventBus logging uses the names of its classes as the log, primarily
+ * "org.scijava.event.bushe.EventService". This aids in debugging which subscription and publication issues.
+ *
+ *
+ * Implementation note: There are no imports in this class to make things
+ * explicit. There is also no explicit use of classes outside java.util,
+ * anything else is used by reflection to avoid NoClassDefFound errors on class load.
+ *
+ */
+class Logger {
+ private java.util.logging.Logger utilLogger;
+ private /*Untyped to avoid java.lang.NoClassDefFoundError
+ org.apache.commons.logging.Log*/ Object commonsLogger;
+ private Map METHOD_CACHE_NO_PARAMS;
+ private Map METHOD_CACHE_ONE_PARAM;
+ private Map METHOD_CACHE_TWO_PARAMS;
+ private static Class logFactoryClass;
+ private static Class logClass;
+ private static Method getLogMethod;
+ private static final Object[] EMPTY_ARGS = new Object[0];
+ private static final Class[] CLASS_ARGS_EMPTY = new Class[0];
+ private static final Class[] CLASS_ARGS_ONE = new Class[]{Object.class};
+ private static final Class[] CLASS_ARGS_TWO = new Class[]{Object.class, Throwable.class};
+
+ /** Allows switching between Java and Commons logging.*/
+ public static enum LoggerType {
+ /*java.util.logging*/
+ JAVA,
+ /*org.apache.commons.logging*/
+ COMMONS
+ }
+
+ /** Standardized logging levels. */
+ public static enum Level {
+ FATAL,
+ ERROR,
+ WARN,
+ INFO,
+ DEBUG,
+ TRACE
+ }
+
+ public static LoggerType LOGGER_TYPE= null;
+
+ public static Logger getLogger(String name) {
+ if (LOGGER_TYPE == null) {
+ LOGGER_TYPE = getLoggerType();
+ }
+ if (LOGGER_TYPE == LoggerType.COMMONS) {
+ try {
+ Object logger = getLogMethod.invoke(null, name);
+ return new Logger(logger);
+ } catch (IllegalAccessException e) {
+ e.printStackTrace();
+ } catch (InvocationTargetException e) {
+ e.printStackTrace();
+ }
+ }
+ return new Logger(java.util.logging.Logger.getLogger(name));
+ }
+
+ /**
+ * This method should only be called once in a JVM run.
+ * @return
+ */
+ private static LoggerType getLoggerType() {
+ LoggerType result = null;
+ //See if apache commons is available
+ try {
+ logFactoryClass = Class.forName("org.apache.commons.logging.LogFactory");
+ getLogMethod = logFactoryClass.getMethod("getLog", new Class[]{String.class});
+ logClass = Class.forName("org.apache.commons.logging.Log");
+ return LoggerType.COMMONS;
+ } catch (Throwable e) {
+ }
+ return LoggerType.JAVA;
+ }
+
+ public Logger(java.util.logging.Logger utilLogger) {
+ this.utilLogger = utilLogger;
+ }
+
+ public Logger(Object commonsLogger) {
+ this.commonsLogger = commonsLogger;
+ }
+
+ /**
+ * Returns whether this level is loggable. If there is
+ * a misconfiguration, this will always return false.
+ * @param level the EventBus Logger level
+ * @return whether this level is loggable.
+ */
+ public boolean isLoggable(Level level) {
+ if (utilLogger != null) {
+ java.util.logging.Level javaLevel = getJavaLevelFor(level);
+ return javaLevel != null && utilLogger.isLoggable(javaLevel);
+ } else if (commonsLogger != null) {
+ switch (level) {
+ case ERROR: return (Boolean)callCommonsLogger("isErrorEnabled");
+ case FATAL: return (Boolean)callCommonsLogger("isFatalEnabled");
+ case WARN: return (Boolean)callCommonsLogger("isWarnEnabled");
+ case INFO: return (Boolean)callCommonsLogger("isInfoEnabled");
+ case DEBUG: return (Boolean)callCommonsLogger("isDebugEnabled");
+ case TRACE: return (Boolean)callCommonsLogger("isTraceEnabled");
+ }
+ }
+ return false;
+ }
+
+ private java.util.logging.Level getJavaLevelFor(Level level) {
+ switch (level) {
+ case FATAL: return java.util.logging.Level.SEVERE;
+ case ERROR: return java.util.logging.Level.SEVERE;
+ case WARN: return java.util.logging.Level.WARNING;
+ case INFO: return java.util.logging.Level.INFO;
+ case DEBUG: return java.util.logging.Level.FINE;
+ case TRACE: return java.util.logging.Level.FINEST;
+ }
+ return null;
+ }
+
+ public void debug(String message) {
+ log(Level.DEBUG, message);
+ }
+
+ public void log(Level level, String message) {
+ log(level, message, null);
+ }
+
+ public void log(Level level, String message, Throwable throwable) {
+ if (!isLoggable(level)) {
+ return;
+ }
+ if (utilLogger != null) {
+ java.util.logging.Level javaLevel = getJavaLevelFor(level);
+ if (throwable == null) {
+ utilLogger.log(javaLevel, message);
+ } else {
+ utilLogger.log(javaLevel, message, throwable);
+ }
+ } else if (commonsLogger != null) {
+ if (throwable == null) {
+ switch (level) {
+ case ERROR: callCommonsLogger("error", message); break;
+ case FATAL: callCommonsLogger("fatal", message); break;
+ case WARN: callCommonsLogger("warn", message); break;
+ case INFO: callCommonsLogger("info", message); break;
+ case DEBUG: callCommonsLogger("debug", message); break;
+ case TRACE: callCommonsLogger("trace", message); break;
+ }
+ } else {
+ switch (level) {
+ case ERROR: callCommonsLogger("error", message, throwable); break;
+ case FATAL: callCommonsLogger("fatal", message, throwable); break;
+ case WARN: callCommonsLogger("warn", message, throwable); break;
+ case INFO: callCommonsLogger("info", message, throwable); break;
+ case DEBUG: callCommonsLogger("debug", message, throwable); break;
+ case TRACE: callCommonsLogger("trace", message, throwable); break;
+ }
+ }
+ }
+ }
+
+ private Object callCommonsLogger(String methodName) {
+ if (METHOD_CACHE_NO_PARAMS == null) {
+ METHOD_CACHE_NO_PARAMS = new HashMap();
+ }
+ return callCommonsLogger(METHOD_CACHE_NO_PARAMS, methodName, CLASS_ARGS_EMPTY, EMPTY_ARGS);
+ }
+
+ private Object callCommonsLogger(String methodName, String message) {
+ if (METHOD_CACHE_ONE_PARAM == null) {
+ METHOD_CACHE_ONE_PARAM = new HashMap();
+ }
+ return callCommonsLogger(METHOD_CACHE_ONE_PARAM, methodName, CLASS_ARGS_ONE, new Object[]{message});
+ }
+
+ private Object callCommonsLogger(String methodName, String message, Throwable throwable) {
+ if (METHOD_CACHE_TWO_PARAMS == null) {
+ METHOD_CACHE_TWO_PARAMS = new HashMap();
+ }
+ return callCommonsLogger(METHOD_CACHE_TWO_PARAMS, methodName, CLASS_ARGS_TWO, new Object[]{message, throwable});
+ }
+
+ private Object callCommonsLogger(Map cache, String methodName, Class[] classOfArgs, Object[] args) {
+ Method method = cache.get(methodName);
+ if (method == null) {
+ try {
+ method = logClass.getMethod(methodName, classOfArgs);
+ cache.put(methodName, method);
+ } catch (NoSuchMethodException e) {
+ e.printStackTrace();
+ }
+ }
+ if (method == null) {
+ return null;
+ }
+ try {
+ return method.invoke(commonsLogger, args);
+ } catch (IllegalAccessException e) {
+ return null;
+ } catch (InvocationTargetException e) {
+ return null;
+ }
+ }
+}
diff --git a/src/main/java/org/scijava/event/bushe/Prioritized.java b/src/main/java/org/scijava/event/bushe/Prioritized.java
new file mode 100644
index 000000000..7a3187055
--- /dev/null
+++ b/src/main/java/org/scijava/event/bushe/Prioritized.java
@@ -0,0 +1,14 @@
+package org.scijava.event.bushe;
+
+/**
+ * Subscribers can implement this interface in order to affect the order in which they are called.
+ *
+ * Subscribers that do not implement this interface are called on a FIFO basis, as are subscribers that implement this
+ * interface and return 0. If the priority returned from this interface is negative, then this subscriber will be
+ * called before non-Prioritized subscribers, the more negative, the earlier it is called. If the priority returned
+ * from this interface is positive, then this subscriber will be called after non-Prioritized subscribers, the more
+ * positive, the later it is called.
+ */
+interface Prioritized {
+ int getPriority();
+}
diff --git a/src/main/java/org/scijava/event/bushe/ProxySubscriber.java b/src/main/java/org/scijava/event/bushe/ProxySubscriber.java
new file mode 100644
index 000000000..04ac3ce0a
--- /dev/null
+++ b/src/main/java/org/scijava/event/bushe/ProxySubscriber.java
@@ -0,0 +1,43 @@
+/**
+ * Copyright 2007 Bushe Enterprises, Inc., Hopkinton, MA, USA, www.bushe.com
+ *
+ * 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.scijava.event.bushe;
+
+/**
+ * An interface that can be implemented when proxies are used for subscription, not needed in normal usage. When an
+ * unsubscribe method is called on an EventService, the EventService is required to check if any of subscribed objects
+ * are ProxySubscribers and if the object to be unsubscribed is the ProxySubscriber's proxiedSubscriber. If so, the
+ * EventService proxy is unsubscribed and the ProxySubscriber's proxyUnsubscribed() method is called to allow the proxy
+ * to perform any cleanup if necessary. ProxySubscribers should set their references to their proxied objects to null
+ * for strong subscriptions to allow garbage collection.
+ *
+ * @author Michael Bushe
+ */
+interface ProxySubscriber {
+
+ /** @return the object this proxy is subscribed on behalf of */
+ public Object getProxiedSubscriber();
+
+ /**
+ * Called by EventServices to inform the proxy that it is unsubscribed. The ProxySubscriber should null the
+ * reference to it's proxied subscriber
+ */
+ public void proxyUnsubscribed();
+
+ /**
+ * @return the reference strength from this proxy to the proxied subscriber
+ */
+ public ReferenceStrength getReferenceStrength();
+}
diff --git a/src/main/java/org/scijava/event/bushe/PublicationStatus.java b/src/main/java/org/scijava/event/bushe/PublicationStatus.java
new file mode 100644
index 000000000..84c0090d0
--- /dev/null
+++ b/src/main/java/org/scijava/event/bushe/PublicationStatus.java
@@ -0,0 +1,30 @@
+package org.scijava.event.bushe;
+
+/**
+ * The status of an event as it makes its way from publication through processing by subscribers.
+ *
+ * EventServices are required to stamp any event object or payload that implements the PublicationStatusTracker
+ * with the corresponding PublicationStatus as the event object is processed. The EventService is not
+ * required to set the Unpublished state.
+ */
+enum PublicationStatus {
+ /** Recommended default.*/
+ Unpublished,
+ /** Set directly after publication on an EventService.*/
+ Initiated,
+ /** End status for events that are vetoed and never sent to subscribers.*/
+ Vetoed,
+ /** State set after veto test is passed before the event is send to any subscribers.*/
+ Queued,
+ /** Set while the event is sent to it's subscribers. EventService implementations
+ * such as the ThreadSafeEventService and the SwingEventService will transition from Queued to
+ * Publishing immediately. Others implementations that call subscribers on threads different
+ * from veto subscribers are free to leave an event in the Queued state and wait until
+ * the event is passed to the thread(s) that subscribers are called on to set the
+ * Publishing state */
+ Publishing,
+ /**
+ * Called when all subscribers have finished handling the event publication.
+ */
+ Completed
+}
diff --git a/src/main/java/org/scijava/event/bushe/PublicationStatusTracker.java b/src/main/java/org/scijava/event/bushe/PublicationStatusTracker.java
new file mode 100644
index 000000000..cc6a98595
--- /dev/null
+++ b/src/main/java/org/scijava/event/bushe/PublicationStatusTracker.java
@@ -0,0 +1,24 @@
+package org.scijava.event.bushe;
+
+/**
+ * An optional interface that can be implemented by Events objects or topic Payloads
+ * to enable the events' status to be stamped on the event by an event service.
+ *
+ * EventService implementations must call setEventStatus(status) on event objects and
+ * payloads that implement this interface.
+ */
+interface PublicationStatusTracker {
+
+ /**
+ * Implementations of this method must be made thread safe.
+ * @return last value set by setPublicationStatus(), or
+ * {@link PublicationStatus#Unpublished} if setPublicationStatus was never called.
+ */
+ public PublicationStatus getPublicationStatus();
+
+ /**
+ * Implementations of this method must be made thread safe.
+ * @param status the status of the event during it's current publication
+ */
+ public void setPublicationStatus(PublicationStatus status);
+}
diff --git a/src/main/java/org/scijava/event/bushe/ReferenceStrength.java b/src/main/java/org/scijava/event/bushe/ReferenceStrength.java
new file mode 100644
index 000000000..15e7a7eb5
--- /dev/null
+++ b/src/main/java/org/scijava/event/bushe/ReferenceStrength.java
@@ -0,0 +1,11 @@
+package org.scijava.event.bushe;
+
+/**
+ * The two kinds of references that are used in the EventBus.
+ *
+ * @author Michael Bushe
+ */
+public enum ReferenceStrength {
+ WEAK,
+ STRONG
+}
diff --git a/src/main/java/org/scijava/event/bushe/SwingException.java b/src/main/java/org/scijava/event/bushe/SwingException.java
new file mode 100644
index 000000000..f36fc36d6
--- /dev/null
+++ b/src/main/java/org/scijava/event/bushe/SwingException.java
@@ -0,0 +1,128 @@
+/**
+ * Copyright 2005 Bushe Enterprises, Inc., Hopkinton, MA, USA, www.bushe.com
+ *
+ * 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.scijava.event.bushe;
+
+import java.io.PrintStream;
+import java.io.PrintWriter;
+
+/**
+ * Aids in troubleshooting Swing application exceptions or any exception where the caller's stack may not be the
+ * exception stack (such as producer-consumer patterns that cross threads).
+ *
+ * Swing exceptions usually occur on the Swing Event Dispatch Thread, and often occur when code puts events on the EDT.
+ * This code is often in a non-EDT thread such as a thread that is receiving data from a server. If the non-EDT threads
+ * puts a call on the EDT and that EDT call causes and exception, the stack trace of the exception is lost, and it often
+ * difficult or impossible to determine where the non-EDT call came from.
+ *
+ *
+ * This Exception class is used to handle exceptions that occur when events are posted on the Swing EDT or occur on
+ * another thread from the Swing EDT. It includes a "swing" call stack to record from where the event occurred, and
+ * overrides so that the exception and the swing calling stack print nicely to logs.
+ *
+ *
+ * The swing calling stack is different from the cause of the exception since it is gathered before the exception occurs
+ * in a different stack from the cause and used after the exception in a new thread occurs.
+ *
+ *
+ * @author Michael Bushe michael@bushe.com
+ */
+class SwingException extends Exception {
+ protected StackTraceElement[] callingStackTrace;
+
+ /** Default constructor */
+ public SwingException() {
+ super();
+ }
+
+ /**
+ * Constructor for compatibility with Exception. Use ClientException(String, Throwable, StackTraceElement[])
+ * instead
+ */
+ public SwingException(String message) {
+ super(message);
+ }
+
+ /** Constructor for compatibility with Exception Use ClientException(String, Throwable, StackTraceElement[]) instead */
+ public SwingException(Throwable cause) {
+ super(cause);
+ }
+
+ /** Constructor for compatibility with Exception Use ClientException(String, Throwable, StackTraceElement[]) instead */
+ public SwingException(String message, Throwable cause) {
+ super(message, cause);
+ }
+
+ /**
+ * Preferred constructor.
+ *
+ * @param message The message of exception
+ * @param cause The cause of the exception in the same call stack
+ * @param callingStack the stack trace that the client used to call the exception to occur.
+ */
+ public SwingException(String message, Throwable cause, StackTraceElement[] callingStack) {
+ super(message, cause);
+ setCallingStack(callingStack);
+ }
+
+ /**
+ * Swing exceptions often have two stacks - one thread causes the posting of an action on another thread - usually
+ * the Swing EDT thread. The other is the stack of the actual thread the exception occurred on, the exception occurs
+ * after the post.
+ *
+ * @param swingCallingStack the stack trace that the client used to cause the exception to occur.
+ */
+ public void setCallingStack(StackTraceElement[] swingCallingStack) {
+ this.callingStackTrace = swingCallingStack;
+ }
+
+ /**
+ * Client exceptions often have two stacks - one thread causes the posting of an action on another thread - usually
+ * the Swing EDT thread. The other is the stack of the actual thread the exception occurred on.
+ *
+ * @return the stack trace that the client used to cause the exception to occur.
+ */
+ public StackTraceElement[] getCallingStack() {
+ return callingStackTrace;
+ }
+
+ /**
+ * Calls printWriter(ps, true)
+ *
+ * @param ps the print stream
+ */
+ public void printStackTrace(PrintStream ps) {
+ PrintWriter pw = new PrintWriter(ps, true);
+ printStackTrace(pw);
+ }
+
+ /**
+ * Prints the calling stack and the exception stack trace.
+ *
+ * @param pw
+ */
+ public void printStackTrace(PrintWriter pw) {
+ pw.println(this);
+ if (callingStackTrace != null) {
+ pw.println("Calling stack:");
+ for (int i = 0; i < callingStackTrace.length; i++) {
+ pw.println("\tat " + callingStackTrace[i]);
+ }
+ pw.println("Stack after call:");
+ }
+ super.printStackTrace(pw);
+ }
+}
+
diff --git a/src/main/java/org/scijava/event/bushe/ThreadSafeEventService.java b/src/main/java/org/scijava/event/bushe/ThreadSafeEventService.java
new file mode 100644
index 000000000..920d0add4
--- /dev/null
+++ b/src/main/java/org/scijava/event/bushe/ThreadSafeEventService.java
@@ -0,0 +1,2180 @@
+/**
+ * Copyright 2005-2007 Bushe Enterprises, Inc., Hopkinton, MA, USA, www.bushe.com
+ *
+ * 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.scijava.event.bushe;
+
+import java.lang.ref.WeakReference;
+import java.lang.reflect.Type;
+import java.lang.reflect.ParameterizedType;
+import java.lang.reflect.WildcardType;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.Timer;
+import java.util.TimerTask;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.regex.Pattern;
+
+import org.scijava.event.bushe.Logger.Level;
+
+/**
+ * A thread-safe EventService implementation.
+ * Multithreading
+ *
+ * This implementation is not Swing thread-safe . If publication occurs on a thread other than the Swing
+ * EventDispatchThread, subscribers will receive the event on the calling thread, and not the EDT. Swing components
+ * should use the SwingEventService instead, which is the implementation used by the EventBus.
+ *
+ *
+ * Two threads may be accessing the ThreadSafeEventService at the same time, one unsubscribing a
+ * listener for topic "A" and the other publishing on topic "A". If the unsubscribing thread gets the lock first,
+ * then it is unsubscribed, end of story. If the publisher gets the lock first, then a snapshot copy of the current
+ * subscribers is made during the publication, the lock is released and the subscribers are called. Between the time
+ * the lock is released and the time that the listener is called, the unsubscribing thread can unsubscribe, resulting
+ * in an unsubscribed object receiving notification of the event after it was unsubscribed (but just once).
+ *
+ *
+ * On event publication, subscribers are called in the order in which they subscribed.
+ *
+ *
+ * Events and/or topic data can be cached, but are not by default. To cache events or topic data, call
+ * {@link #setDefaultCacheSizePerClassOrTopic(int)}, {@link #setCacheSizeForEventClass(Class, int)}, or
+ * {@link #setCacheSizeForTopic(String, int)}, {@link #setCacheSizeForTopic(Pattern, int)}. Retrieve cached values
+ * with {@link #getLastEvent(Class)}, {@link #getLastTopicData(String)}, {@link #getCachedEvents(Class)}, or
+ * {@link #getCachedTopicData(String)}. Using caching while subscribing
+ * is most likely to make sense only if you subscribe and publish on the same thread (so caching is very useful for
+ * Swing applications since both happen on the EDT in a single-threaded manner). In multithreaded applications, you
+ * never know if your subscriber has handled an event while it was being subscribed (before the subscribe() method
+ * returned) that is newer or older than the retrieved cached value (taken before or after subscribe() respectively).
+ *
+ * Logging
+ *
+ * All logging goes through the {@link Logger}. The Logger is configurable and supports multiple logging systems.
+ *
+ *
+ * Exceptions are logged by default, override {@link #handleException(String,Object,String,Object,Throwable,
+ * StackTraceElement[],String)} to handleException exceptions in another way. Each call to a subscriber is wrapped in
+ * a try block to ensure one listener does not interfere with another.
+ *
+ * Cleanup of Stale WeakReferences and Stale Annotation Proxies
+ *
+ * The EventService may need to clean up stale WeakReferences and ProxySubscribers created for EventBus annotations. (Aside: EventBus
+ * Annotations are handled by the creation of proxies to the annotated objects. Since the annotations create weak references
+ * by default, annotation proxies must held strongly by the EventService, otherwise the proxy is garbage collected.) When
+ * a WeakReference's referent or an ProxySubscriber's proxiedObject (the annotated object) is claimed by the garbage collector,
+ * the EventService still holds onto the actual WeakReference or ProxySubscriber subscribed to the EventService (which are pretty tiny).
+ *
+ *
+ * There are two ways that these stale WeakReferences and ProxySubscribers are cleaned up.
+ *
+ *
+ * On every publish, subscribe and unsubscribe, every subscriber and veto subscriber to a class or topic is checked to see
+ * if it is a stale WeakReference or a stale ProxySubscriber (one whose getProxySubscriber() returns null). If the subscriber
+ * is stale, it is unsubscribed from the EventService immediately. If it is a ProxySubscriber, it's proxyUnsubscribed()
+ * method is called after it is unsubscribed. (This isn't as expensive as it sounds, since checks to avoid double subscription is
+ * necessary anyway).
+ * Another cleanup thread may get started to clean up remaining stale subscribers. This cleanup thread only comes into
+ * play for subscribers to topic or classes that haven't been used (published/subscribed/unsibscribed to). A detailed description
+ * of the cleanup thread follows.
+ *
+ * The Cleanup Thread
+ *
+ * If a topic or class is never published to again, WeakReferences and ProxySubscribers can be left behind if they
+ * are not cleaned up. To prevent loitering stale subscribers, the ThreadSafeEventService may periodically run through
+ * all the EventSubscribers and VetoSubscribers for all topics and classes and clean up stale proxies. Proxies for
+ * Annotations that have a ReferenceStrength.STRONG are never cleaned up in normal usage. (By specifying
+ * ReferenceStrength.STRONG, the programmer is buying into unsubscribing annotated objects themselves. There is
+ * one caveat: If getProxiedSubscriber() returns null, even for a ProxySubscriber with a STRONG reference strength, that proxy
+ * is cleaned up as it is assumed it is stale or just wrong. This would not occur normally in EventBus usage, but only
+ * if someone is implementing their own custom ProxySubscriber and/or AnnotationProcessor.)
+ *
+ *
+ * Cleanup is pretty rare in general. Not only are stale subscribers cleaned up with regular usage, stale
+ * subscribers on abandoned topics and classes do not take up a lot of memory, hence, they are allowed to build up to a certain degree.
+ * Cleanup does not occur until the number of WeakReferences and SubscriptionsProxy's with WeakReference strength
+ * subscribed to an EventService for all the EventService's subscriptions in total exceed the cleanupStartThreshhold ,
+ * which is set to CLEANUP_START_THRESHOLD_DEFAULT (500) by default. The default is overridable in the constructor
+ * or via #setCleanupStartThreshhold(Integer). If set to null, cleanup will never start.
+ *
+ *
+ * Once the cleanup start threshold is exceeded, a java.util.Timer is started to clean up stale subscribers periodically
+ * in another thread. The timer will fire every cleanupPeriodMS milliseconds, which is set to the
+ * CLEANUP_PERIOD_MS_DEFAULT (20 minutes) by default. The default is overridable in the constructor or
+ * via #setCleanupPeriodMS(Integer). If set to null, cleanup will not start. This is implemented with a java.util.Timer ,
+ * so Timer's warnings apply - setting this too low will cause cleanups to bunch up and hog the cleanup thread.
+ *
+ *
+ * After a cleanup cycle completes, if the number of stale subscribers falls at or below the cleanupStopThreshhold
+ * cleanup stops until the cleanupStartThreshhold is exceeded again. The cleanupStopThreshhold is set
+ * to CLEANUP_STOP_THRESHOLD_DEFAULT (100) by default. The default is overridable in the constructor or via
+ * #setCleanupStopThreshhold(Integer). If set to null or 0, cleanup will not stop if it is ever started.
+ *
+ *
+ * All cleanup parameters are tunable "live" and checked after each subscription and after each cleanup cycle.
+ * To make cleanup never run, set cleanupStartThreshhold to Integer.MAX_VALUE and cleanupPeriodMS to null.
+ * To get cleanup to run continuously, set set cleanupStartThreshhold to 0 and cleanupPeriodMS to some reasonable value,
+ * perhaps 1000 (1 second) or so (not recommended, cleanup is conducted with regular usage and the cleanup thread is
+ * rarely created or invoked).
+ *
+ *
+ * Cleanup is not run in a daemon thread, and thus will not stop the JVM from exiting.
+ *
+ *
+ * @author Michael Bushe michael@bushe.com
+ * @see EventService for a complete description of the API
+ */
+@SuppressWarnings({"unchecked"})
+public class ThreadSafeEventService implements EventService {
+ public static final Integer CLEANUP_START_THRESHOLD_DEFAULT = 250;
+ public static final Integer CLEANUP_STOP_THRESHOLD_DEFAULT = 100;
+ public static final Long CLEANUP_PERIOD_MS_DEFAULT = 20L*60L*1000L;
+
+ protected static final Logger LOG = Logger.getLogger(EventService.class.getName());
+
+ //Making these generic collections is a bad idea, it doesn't compile since it's better to have all the maps
+ //go through the same set of code to do all the real publish and subscribe work
+ private Map subscribersByEventType = new HashMap();
+ private Map subscribersByEventClass = new HashMap();
+ private Map subscribersByExactEventClass = new HashMap();
+ private Map subscribersByTopic = new HashMap();
+ private Map subscribersByTopicPattern = new HashMap();
+ private Map vetoListenersByClass = new HashMap();
+ private Map vetoListenersByExactClass = new HashMap();
+ private Map vetoListenersByTopic = new HashMap();
+ private Map vetoListenersByTopicPattern = new HashMap();
+ private final Object listenerLock = new Object();
+ private final Object cacheLock = new Object();
+ private Long timeThresholdForEventTimingEventPublication;
+ private Map cacheByEvent = new HashMap();
+ private int defaultCacheSizePerClassOrTopic = 0;
+ private Map cacheSizesForEventClass;
+ private Map rawCacheSizesForEventClass;
+ private boolean rawCacheSizesForEventClassChanged;
+ private Map cacheByTopic = new HashMap();
+ private Map cacheSizesForTopic;
+ private Map rawCacheSizesForTopic;
+ private boolean rawCacheSizesForTopicChanged;
+ private Map rawCacheSizesForPattern;
+ private boolean rawCacheSizesForPatternChanged;
+ private Integer cleanupStartThreshhold;
+ private Integer cleanupStopThreshold;
+ private Long cleanupPeriodMS;
+ private int weakRefPlusProxySubscriberCount;
+ private Timer cleanupTimer;
+ private TimerTask cleanupTimerTask;
+ private static final Comparator PRIORITIZED_SUBSCRIBER_COMPARATOR = new PrioritizedSubscriberComparator();
+ private boolean hasEverUsedPrioritized;
+
+ /** Creates a ThreadSafeEventService that does not monitor timing of handlers. */
+ public ThreadSafeEventService() {
+ this(null, null, null, null);
+ }
+
+ /**
+ * Creates a ThreadSafeEventService while providing time monitoring options.
+ *
+ * @param timeThresholdForEventTimingEventPublication the longest time a subscriber should spend handling an event,
+ * The service will publish an SubscriberTimingEvent after listener processing if the time was exceeded. If null, no
+ * EventSubscriberTimingEvent will be issued.
+ */
+ public ThreadSafeEventService(Long timeThresholdForEventTimingEventPublication) {
+ this(timeThresholdForEventTimingEventPublication, null, null, null);
+ }
+
+ /**
+ * Creates a ThreadSafeEventService while providing proxy cleanup customization.
+ * Proxies are used with Annotations.
+ *
+ * @param cleanupStartThreshold see class javadoc.
+ * @param cleanupStopThreshold see class javadoc.
+ * @param cleanupPeriodMS see class javadoc.
+ */
+ public ThreadSafeEventService(Integer cleanupStartThreshold,
+ Integer cleanupStopThreshold, Long cleanupPeriodMS) {
+ this(null, cleanupStartThreshold, cleanupStopThreshold, cleanupPeriodMS);
+ }
+
+ /**
+ * Creates a ThreadSafeEventService while providing time monitoring options.
+ *
+ * @param timeThresholdForEventTimingEventPublication the longest time a subscriber should spend handling an event.
+ * The service will publish an SubscriberTimingEvent after listener processing if the time was exceeded. If null, no
+ * SubscriberTimingEvent will be issued.
+ * @param cleanupStartThreshold see class javadoc.
+ * @param cleanupStopThreshold see class javadoc.
+ * @param cleanupPeriodMS see class javadoc.
+ */
+ public ThreadSafeEventService(Long timeThresholdForEventTimingEventPublication,
+ Integer cleanupStartThreshold, Integer cleanupStopThreshold, Long cleanupPeriodMS) {
+ this.timeThresholdForEventTimingEventPublication = timeThresholdForEventTimingEventPublication;
+ if (cleanupStartThreshold == null) {
+ this.cleanupStartThreshhold = CLEANUP_START_THRESHOLD_DEFAULT;
+ } else {
+ this.cleanupStartThreshhold = cleanupStartThreshold;
+ }
+ if (cleanupStopThreshold == null) {
+ this.cleanupStopThreshold = CLEANUP_STOP_THRESHOLD_DEFAULT;
+ } else {
+ this.cleanupStopThreshold = cleanupStopThreshold;
+ }
+ if (cleanupPeriodMS == null) {
+ this.cleanupPeriodMS = CLEANUP_PERIOD_MS_DEFAULT;
+ } else {
+ this.cleanupPeriodMS = cleanupPeriodMS;
+ }
+ }
+
+ /**
+ * Gets the threshold above which cleanup starts. See the class javadoc on cleanup.
+ * @return the threshold at which cleanup starts
+ */
+ public Integer getCleanupStartThreshhold() {
+ synchronized (listenerLock) {
+ return cleanupStartThreshhold;
+ }
+ }
+
+ /**
+ * Sets the threshold above which cleanup starts. See the class javadoc on cleanup.
+ * @param cleanupStartThreshhold threshold at which cleanup starts
+ */
+ public void setCleanupStartThreshhold(Integer cleanupStartThreshhold) {
+ synchronized (listenerLock) {
+ this.cleanupStartThreshhold = cleanupStartThreshhold;
+ }
+ }
+
+ /**
+ * Gets the threshold below which cleanup stops. See the class javadoc on cleanup.
+ * @return threshold at which cleanup stops (it may start again)
+ */
+ public Integer getCleanupStopThreshold() {
+ synchronized (listenerLock) {
+ return cleanupStopThreshold;
+ }
+ }
+
+ /**
+ * Sets the threshold below which cleanup stops. See the class javadoc on cleanup.
+ * @param cleanupStopThreshold threshold at which cleanup stops (it may start again).
+ */
+ public void setCleanupStopThreshold(Integer cleanupStopThreshold) {
+ synchronized (listenerLock) {
+ this.cleanupStopThreshold = cleanupStopThreshold;
+ }
+ }
+
+ /**
+ * Get the cleanup interval. See the class javadoc on cleanup.
+ * @return interval in milliseconds between cleanup runs.
+ */
+ public Long getCleanupPeriodMS() {
+ synchronized (listenerLock) {
+ return cleanupPeriodMS;
+ }
+ }
+
+ /**
+ * Sets the cleanup interval. See the class javadoc on cleanup.
+ * @param cleanupPeriodMS interval in milliseconds between cleanup runs. Passing null
+ * stops cleanup.
+ */
+ public void setCleanupPeriodMS(Long cleanupPeriodMS) {
+ synchronized (listenerLock) {
+ this.cleanupPeriodMS = cleanupPeriodMS;
+ }
+ }
+
+ /** @see EventService#subscribe(Class,EventSubscriber) */
+ public boolean subscribe(Class cl, EventSubscriber eh) {
+ if (cl == null) {
+ throw new IllegalArgumentException("Event class must not be null");
+ }
+ if (eh == null) {
+ throw new IllegalArgumentException("Event subscriber must not be null");
+ }
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("Subscribing by class, class:" + cl + ", subscriber:" + eh);
+ }
+ return subscribe(cl, subscribersByEventClass, new WeakReference(eh));
+ }
+
+ /** @see EventService#subscribe(java.lang.reflect.Type, EventSubscriber) */
+ public boolean subscribe(Type type, EventSubscriber eh) {
+ return subscribe(type, subscribersByEventType, new WeakReference(eh));
+ }
+
+ /** @see EventService#subscribeExactly(Class,EventSubscriber) */
+ public boolean subscribeExactly(Class cl, EventSubscriber eh) {
+ if (cl == null) {
+ throw new IllegalArgumentException("Event class must not be null");
+ }
+ if (eh == null) {
+ throw new IllegalArgumentException("Event subscriber must not be null");
+ }
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("Subscribing by class, class:" + cl + ", subscriber:" + eh);
+ }
+ return subscribe(cl, subscribersByExactEventClass, new WeakReference(eh));
+ }
+
+ /** @see EventService#subscribe(String,EventTopicSubscriber) */
+ public boolean subscribe(String topic, EventTopicSubscriber eh) {
+ if (topic == null) {
+ throw new IllegalArgumentException("Topic must not be null");
+ }
+ if (eh == null) {
+ throw new IllegalArgumentException("Event topic subscriber must not be null");
+ }
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("Subscribing by topic name, name:" + topic + ", subscriber:" + eh);
+ }
+ return subscribe(topic, subscribersByTopic, new WeakReference(eh));
+ }
+
+ /** @see EventService#subscribe(Pattern,EventTopicSubscriber) */
+ public boolean subscribe(Pattern pat, EventTopicSubscriber eh) {
+ if (pat == null) {
+ throw new IllegalArgumentException("Pattern must not be null");
+ }
+ if (eh == null) {
+ throw new IllegalArgumentException("Event subscriber must not be null");
+ }
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("Subscribing by pattern, pattern:" + pat + ", subscriber:" + eh);
+ }
+ PatternWrapper patternWrapper = new PatternWrapper(pat);
+ return subscribe(patternWrapper, subscribersByTopicPattern, new WeakReference(eh));
+ }
+
+ /** @see EventService#subscribeStrongly(Class,EventSubscriber) */
+ public boolean subscribeStrongly(Class cl, EventSubscriber eh) {
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("Subscribing weakly by class, class:" + cl + ", subscriber:" + eh);
+ }
+ if (eh == null) {
+ throw new IllegalArgumentException("Subscriber cannot be null.");
+ }
+ return subscribe(cl, subscribersByEventClass, eh);
+ }
+
+ /** @see EventService#subscribeExactlyStrongly(Class,EventSubscriber) */
+ public boolean subscribeExactlyStrongly(Class cl, EventSubscriber eh) {
+ if (cl == null) {
+ throw new IllegalArgumentException("Event class must not be null");
+ }
+ if (eh == null) {
+ throw new IllegalArgumentException("Event subscriber must not be null");
+ }
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("Subscribing by class, class:" + cl + ", subscriber:" + eh);
+ }
+ return subscribe(cl, subscribersByExactEventClass, eh);
+ }
+
+ /** @see EventService#subscribeStrongly(String,EventTopicSubscriber) */
+ public boolean subscribeStrongly(String name, EventTopicSubscriber eh) {
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("Subscribing weakly by topic name, name:" + name + ", subscriber:" + eh);
+ }
+ if (eh == null) {
+ throw new IllegalArgumentException("Subscriber cannot be null.");
+ }
+ return subscribe(name, subscribersByTopic, eh);
+ }
+
+ /** @see EventService#subscribeStrongly(Pattern,EventTopicSubscriber) */
+ public boolean subscribeStrongly(Pattern pat, EventTopicSubscriber eh) {
+ if (pat == null) {
+ throw new IllegalArgumentException("Pattern must not be null");
+ }
+ if (eh == null) {
+ throw new IllegalArgumentException("Event subscriber must not be null");
+ }
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("Subscribing by pattern, pattern:" + pat + ", subscriber:" + eh);
+ }
+ PatternWrapper patternWrapper = new PatternWrapper(pat);
+ return subscribe(patternWrapper, subscribersByTopicPattern, eh);
+ }
+
+
+ /** @see org.scijava.event.bushe.EventService#clearAllSubscribers() */
+ public void clearAllSubscribers() {
+ synchronized (listenerLock) {
+ unsubscribeAllInMap(subscribersByEventType);
+ unsubscribeAllInMap(subscribersByEventClass);
+ unsubscribeAllInMap(subscribersByExactEventClass);
+ unsubscribeAllInMap(subscribersByTopic);
+ unsubscribeAllInMap(subscribersByTopicPattern);
+ unsubscribeAllInMap(vetoListenersByClass);
+ unsubscribeAllInMap(vetoListenersByExactClass);
+ unsubscribeAllInMap(vetoListenersByTopic);
+ unsubscribeAllInMap(vetoListenersByTopicPattern);
+ }
+ }
+
+ private void unsubscribeAllInMap(Map subscriberMap) {
+ synchronized (listenerLock) {
+ Set subscriptionKeys = subscriberMap.keySet();
+ for (Object key : subscriptionKeys) {
+ List subscribers = (List) subscriberMap.get(key);
+ while (!subscribers.isEmpty()) {
+ unsubscribe(key, subscriberMap, subscribers.get(0));
+ }
+ }
+ }
+ }
+
+ /** @see EventService#subscribeVetoListener(Class,VetoEventListener) */
+ public boolean subscribeVetoListener(Class eventClass, VetoEventListener vetoListener) {
+ if (vetoListener == null) {
+ throw new IllegalArgumentException("VetoEventListener cannot be null.");
+ }
+ if (eventClass == null) {
+ throw new IllegalArgumentException("eventClass cannot be null.");
+ }
+ return subscribeVetoListener(eventClass, vetoListenersByClass, new WeakReference(vetoListener));
+ }
+
+ /** @see EventService#subscribeVetoListenerExactly(Class,VetoEventListener) */
+ public boolean subscribeVetoListenerExactly(Class eventClass, VetoEventListener vetoListener) {
+ if (vetoListener == null) {
+ throw new IllegalArgumentException("VetoEventListener cannot be null.");
+ }
+ if (eventClass == null) {
+ throw new IllegalArgumentException("eventClass cannot be null.");
+ }
+ return subscribeVetoListener(eventClass, vetoListenersByExactClass, new WeakReference(vetoListener));
+ }
+
+ /** @see EventService#subscribeVetoListener(String,VetoTopicEventListener) */
+ public boolean subscribeVetoListener(String topic, VetoTopicEventListener vetoListener) {
+ if (vetoListener == null) {
+ throw new IllegalArgumentException("VetoEventListener cannot be null.");
+ }
+ if (topic == null) {
+ throw new IllegalArgumentException("topic cannot be null.");
+ }
+ return subscribeVetoListener(topic, vetoListenersByTopic, new WeakReference(vetoListener));
+ }
+
+ /** @see EventService#subscribeVetoListener(Pattern,VetoTopicEventListener) */
+ public boolean subscribeVetoListener(Pattern topicPattern, VetoTopicEventListener vetoListener) {
+ if (vetoListener == null) {
+ throw new IllegalArgumentException("VetoEventListener cannot be null.");
+ }
+ if (topicPattern == null) {
+ throw new IllegalArgumentException("topicPattern cannot be null.");
+ }
+ PatternWrapper patternWrapper = new PatternWrapper(topicPattern);
+ return subscribeVetoListener(patternWrapper, vetoListenersByTopicPattern, new WeakReference(vetoListener));
+ }
+
+ /** @see EventService#subscribeVetoListenerStrongly(Class,VetoEventListener) */
+ public boolean subscribeVetoListenerStrongly(Class eventClass, VetoEventListener vetoListener) {
+ if (vetoListener == null) {
+ throw new IllegalArgumentException("VetoEventListener cannot be null.");
+ }
+ if (eventClass == null) {
+ throw new IllegalArgumentException("eventClass cannot be null.");
+ }
+ return subscribeVetoListener(eventClass, vetoListenersByClass, vetoListener);
+ }
+
+ /** @see EventService#subscribeVetoListenerExactlyStrongly(Class,VetoEventListener) */
+ public boolean subscribeVetoListenerExactlyStrongly(Class eventClass, VetoEventListener vetoListener) {
+ if (vetoListener == null) {
+ throw new IllegalArgumentException("VetoEventListener cannot be null.");
+ }
+ if (eventClass == null) {
+ throw new IllegalArgumentException("eventClass cannot be null.");
+ }
+ return subscribeVetoListener(eventClass, vetoListenersByExactClass, vetoListener);
+ }
+
+ /** @see EventService#subscribeVetoListenerStrongly(String,VetoTopicEventListener) */
+ public boolean subscribeVetoListenerStrongly(String topic, VetoTopicEventListener vetoListener) {
+ if (vetoListener == null) {
+ throw new IllegalArgumentException("VetoListener cannot be null.");
+ }
+ if (topic == null) {
+ throw new IllegalArgumentException("topic cannot be null.");
+ }
+ return subscribeVetoListener(topic, vetoListenersByTopic, vetoListener);
+ }
+
+ /** @see EventService#subscribeVetoListenerStrongly(Pattern,VetoTopicEventListener) */
+ public boolean subscribeVetoListenerStrongly(Pattern topicPattern, VetoTopicEventListener vetoListener) {
+ if (vetoListener == null) {
+ throw new IllegalArgumentException("VetoTopicEventListener cannot be null.");
+ }
+ if (topicPattern == null) {
+ throw new IllegalArgumentException("topicPattern cannot be null.");
+ }
+ PatternWrapper patternWrapper = new PatternWrapper(topicPattern);
+ return subscribeVetoListener(patternWrapper, vetoListenersByTopicPattern, vetoListener);
+ }
+
+ /**
+ * All veto subscriptions methods call this method. Extending classes only have to override this method to subscribe
+ * all veto subscriptions.
+ *
+ * @param subscription the topic, Pattern, or event class to subscribe to
+ * @param vetoListenerMap the internal map of veto listeners to use (by topic of class)
+ * @param vetoListener the veto listener to subscribe, may be a VetoEventListener or a WeakReference to one
+ *
+ * @return boolean if the veto listener is subscribed (was not subscribed).
+ *
+ * @throws IllegalArgumentException if vl or o is null
+ */
+ protected boolean subscribeVetoListener(final Object subscription, final Map vetoListenerMap, final Object vetoListener) {
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("subscribeVetoListener(" + subscription + "," + vetoListener + ")");
+ }
+ if (vetoListener == null) {
+ throw new IllegalArgumentException("Can't subscribe null veto listener to " + subscription);
+ }
+ if (subscription == null) {
+ throw new IllegalArgumentException("Can't subscribe veto listener to null.");
+ }
+ return subscribe(subscription, vetoListenerMap, vetoListener);
+ }
+
+ /**
+ * All subscribe methods call this method, including veto subscriptions.
+ * Extending classes only have to override this method to subscribe all
+ * subscriber subscriptions.
+ *
+ * Overriding this method is only for the adventurous. This basically gives you just enough rope to hang yourself.
+ *
+ *
+ * @param classTopicOrPatternWrapper the topic String, event Class, or PatternWrapper to subscribe to
+ * @param subscriberMap the internal map of subscribers to use (by topic or class)
+ * @param subscriber the EventSubscriber or EventTopicSubscriber to subscribe, or a WeakReference to either
+ *
+ * @return boolean if the subscriber is subscribed (was not subscribed).
+ *
+ * @throws IllegalArgumentException if subscriber or topicOrClass is null
+ */
+ protected boolean subscribe(final Object classTopicOrPatternWrapper, final Map subscriberMap, final Object subscriber) {
+ if (classTopicOrPatternWrapper == null) {
+ throw new IllegalArgumentException("Can't subscribe to null.");
+ }
+ if (subscriber == null) {
+ throw new IllegalArgumentException("Can't subscribe null subscriber to " + classTopicOrPatternWrapper);
+ }
+ boolean alreadyExists = false;
+
+ //Find the real subscriber underlying weak refs and proxies
+ Object realSubscriber = subscriber;
+ boolean isWeakRef = subscriber instanceof WeakReference;
+ if (isWeakRef) {
+ realSubscriber = ((WeakReference) subscriber).get();
+ }
+ if (realSubscriber instanceof Prioritized) {
+ hasEverUsedPrioritized = true;
+ }
+ boolean isWeakProxySubscriber = false;
+ if (subscriber instanceof ProxySubscriber) {
+ ProxySubscriber proxySubscriber = (ProxySubscriber) subscriber;
+ if (proxySubscriber instanceof Prioritized) {
+ hasEverUsedPrioritized = true;
+ }
+ isWeakProxySubscriber = proxySubscriber.getReferenceStrength() == ReferenceStrength.WEAK;
+ if (isWeakProxySubscriber) {
+ realSubscriber = ((ProxySubscriber) subscriber).getProxiedSubscriber();
+ }
+ }
+ if (isWeakRef && isWeakProxySubscriber) {
+ throw new IllegalArgumentException("ProxySubscribers should always be subscribed strongly.");
+ }
+ if (realSubscriber == null) {
+ return false;//already garbage collected? Weird.
+ }
+ synchronized (listenerLock) {
+ List currentSubscribers = (List) subscriberMap.get(classTopicOrPatternWrapper);
+ if (currentSubscribers == null) {
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("Creating new subscriber map for:" + classTopicOrPatternWrapper);
+ }
+ currentSubscribers = new ArrayList();
+ subscriberMap.put(classTopicOrPatternWrapper, currentSubscribers);
+ } else {
+ //Double subscription check and stale subscriber cleanup
+ //Need to compare the underlying referents for WeakReferences and ProxySubscribers
+ //to make sure a weak ref and a hard ref aren't both subscribed
+ //to the same topic and object.
+ //Use the proxied subscriber for comparison if a ProxySubscribers is used
+ //Subscribing the same object by proxy and subscribing explicitly should
+ //not subscribe the same object twice
+ for (Iterator iterator = currentSubscribers.iterator(); iterator.hasNext();) {
+ Object currentSubscriber = iterator.next();
+ Object realCurrentSubscriber = getRealSubscriberAndCleanStaleSubscriberIfNecessary(iterator, currentSubscriber);
+ if (realSubscriber.equals(realCurrentSubscriber)) {
+ //Already subscribed.
+ //Remove temporarily, to add to the end of the calling list
+ iterator.remove();
+ alreadyExists = true;
+ }
+ }
+ }
+ currentSubscribers.add(subscriber);
+ if (isWeakProxySubscriber || isWeakRef) {
+ incWeakRefPlusProxySubscriberCount();
+ }
+ return !alreadyExists;
+ }
+ }
+
+ /** @see EventService#unsubscribe(Class,EventSubscriber) */
+ public boolean unsubscribe(Class cl, EventSubscriber eh) {
+ return unsubscribe(cl, subscribersByEventClass, eh);
+ }
+
+ /** @see EventService#unsubscribeExactly(Class,EventSubscriber) */
+ public boolean unsubscribeExactly(Class cl, EventSubscriber eh) {
+ return unsubscribe(cl, subscribersByExactEventClass, eh);
+ }
+
+ /** @see EventService#unsubscribe(String,EventTopicSubscriber) */
+ public boolean unsubscribe(String name, EventTopicSubscriber eh) {
+ return unsubscribe(name, subscribersByTopic, eh);
+ }
+
+ /** @see EventService#unsubscribe(String,EventTopicSubscriber) */
+ public boolean unsubscribe(Pattern topicPattern, EventTopicSubscriber eh) {
+ PatternWrapper patternWrapper = new PatternWrapper(topicPattern);
+ return unsubscribe(patternWrapper, subscribersByTopicPattern, eh);
+ }
+
+ /** @see EventService#unsubscribe(Class,Object) */
+ public boolean unsubscribe(Class eventClass, Object subscribedByProxy) {
+ EventSubscriber subscriber = (EventSubscriber) getProxySubscriber(eventClass, subscribedByProxy);
+ if (subscriber == null) {
+ return false;
+ } else {
+ return unsubscribe(eventClass, subscriber);
+ }
+ }
+
+ /** @see EventService#unsubscribeExactly(Class,Object) */
+ public boolean unsubscribeExactly(Class eventClass, Object subscribedByProxy) {
+ EventSubscriber subscriber = (EventSubscriber) getProxySubscriber(eventClass, subscribedByProxy);
+ if (subscriber == null) {
+ return false;
+ } else {
+ return unsubscribeExactly(eventClass, subscriber);
+ }
+ }
+
+ /** @see EventService#unsubscribe(String,Object) */
+ public boolean unsubscribe(String topic, Object subscribedByProxy) {
+ EventTopicSubscriber subscriber = (EventTopicSubscriber) getProxySubscriber(topic, subscribedByProxy);
+ if (subscriber == null) {
+ return false;
+ } else {
+ return unsubscribe(topic, subscriber);
+ }
+ }
+
+ /** @see EventService#unsubscribe(java.util.regex.Pattern,Object) */
+ public boolean unsubscribe(Pattern pattern, Object subscribedByProxy) {
+ EventTopicSubscriber subscriber = (EventTopicSubscriber) getProxySubscriber(pattern, subscribedByProxy);
+ if (subscriber == null) {
+ return false;
+ } else {
+ return unsubscribe(pattern, subscriber);
+ }
+ }
+
+ /**
+ * All event subscriber unsubscriptions call this method. Extending classes only have to override this method to
+ * subscribe all subscriber unsubscriptions.
+ *
+ * @param o the topic or event class to unsubscribe from
+ * @param subscriberMap the map of subscribers to use (by topic of class)
+ * @param subscriber the subscriber to unsubscribe, either an EventSubscriber or an EventTopicSubscriber, or a WeakReference
+ * to either
+ *
+ * @return boolean if the subscriber is unsubscribed (was subscribed).
+ */
+ protected boolean unsubscribe(Object o, Map subscriberMap, Object subscriber) {
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("unsubscribe(" + o + "," + subscriber + ")");
+ }
+ if (o == null) {
+ throw new IllegalArgumentException("Can't unsubscribe to null.");
+ }
+ if (subscriber == null) {
+ throw new IllegalArgumentException("Can't unsubscribe null subscriber to " + o);
+ }
+ synchronized (listenerLock) {
+ return removeFromSetResolveWeakReferences(subscriberMap, o, subscriber);
+ }
+ }
+
+ /** @see EventService#unsubscribeVeto(Class,Object) */
+ public boolean unsubscribeVeto(Class eventClass, Object subscribedByProxy) {
+ VetoEventListener subscriber = (VetoEventListener) getVetoProxySubscriber(eventClass, subscribedByProxy);
+ if (subscriber == null) {
+ return false;
+ } else {
+ return unsubscribeVetoListener(eventClass, subscriber);
+ }
+ }
+
+ /** @see EventService#unsubscribeVetoExactly(Class,Object) */
+ public boolean unsubscribeVetoExactly(Class eventClass, Object subscribedByProxy) {
+ VetoEventListener subscriber = (VetoEventListener) getVetoProxySubscriber(eventClass, subscribedByProxy);
+ if (subscriber == null) {
+ return false;
+ } else {
+ return unsubscribeVetoListenerExactly(eventClass, subscriber);
+ }
+ }
+
+ /** @see EventService#unsubscribeVeto(String,Object) */
+ public boolean unsubscribeVeto(String topic, Object subscribedByProxy) {
+ VetoTopicEventListener subscriber = (VetoTopicEventListener) getVetoProxySubscriber(topic, subscribedByProxy);
+ if (subscriber == null) {
+ return false;
+ } else {
+ return unsubscribeVetoListener(topic, subscriber);
+ }
+ }
+
+ /** @see EventService#unsubscribeVeto(java.util.regex.Pattern,Object) */
+ public boolean unsubscribeVeto(Pattern pattern, Object subscribedByProxy) {
+ VetoTopicEventListener subscriber = (VetoTopicEventListener) getVetoProxySubscriber(pattern, subscribedByProxy);
+ if (subscriber == null) {
+ return false;
+ } else {
+ return unsubscribeVetoListener(pattern, subscriber);
+ }
+ }
+
+ /** @see EventService#unsubscribeVetoListener(Class,VetoEventListener) */
+ public boolean unsubscribeVetoListener(Class eventClass, VetoEventListener vetoListener) {
+ return unsubscribeVetoListener(eventClass, vetoListenersByClass, vetoListener);
+ }
+
+ /** @see EventService#unsubscribeVetoListenerExactly(Class,VetoEventListener) */
+ public boolean unsubscribeVetoListenerExactly(Class eventClass, VetoEventListener vetoListener) {
+ return unsubscribeVetoListener(eventClass, vetoListenersByExactClass, vetoListener);
+ }
+
+ /** @see EventService#unsubscribeVetoListener(String,VetoTopicEventListener) */
+ public boolean unsubscribeVetoListener(String topic, VetoTopicEventListener vetoListener) {
+ return unsubscribeVetoListener(topic, vetoListenersByTopic, vetoListener);
+ }
+
+ /** @see EventService#unsubscribeVetoListener(Pattern,VetoTopicEventListener) */
+ public boolean unsubscribeVetoListener(Pattern topicPattern, VetoTopicEventListener vetoListener) {
+ PatternWrapper patternWrapper = new PatternWrapper(topicPattern);
+ return unsubscribeVetoListener(patternWrapper, vetoListenersByTopicPattern, vetoListener);
+ }
+
+ /**
+ * All veto unsubscriptions methods call this method. Extending classes only have to override this method to
+ * subscribe all veto unsubscriptions.
+ *
+ * @param o the topic or event class to unsubscribe from
+ * @param vetoListenerMap the map of veto listeners to use (by topic or class)
+ * @param vl the veto listener to unsubscribe, or a WeakReference to one
+ *
+ * @return boolean if the veto listener is unsubscribed (was subscribed).
+ */
+ protected boolean unsubscribeVetoListener(Object o, Map vetoListenerMap, Object vl) {
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("unsubscribeVetoListener(" + o + "," + vl + ")");
+ }
+ if (o == null) {
+ throw new IllegalArgumentException("Can't unsubscribe veto listener to null.");
+ }
+ if (vl == null) {
+ throw new IllegalArgumentException("Can't unsubscribe null veto listener to " + o);
+ }
+ synchronized (listenerLock) {
+ return removeFromSetResolveWeakReferences(vetoListenerMap, o, vl);
+ }
+ }
+
+ private ProxySubscriber getProxySubscriber(Class eventClass, Object subscribedByProxy) {
+ List subscribers = getSubscribers(eventClass);
+ return getProxySubscriber(subscribers, subscribedByProxy);
+ }
+
+ private ProxySubscriber getProxySubscriber(String topic, Object subscribedByProxy) {
+ List subscribers = getSubscribers(topic);
+ return getProxySubscriber(subscribers, subscribedByProxy);
+ }
+
+ private ProxySubscriber getProxySubscriber(Pattern pattern, Object subscribedByProxy) {
+ List subscribers = getSubscribersToPattern(pattern);
+ return getProxySubscriber(subscribers, subscribedByProxy);
+ }
+
+ private ProxySubscriber getVetoProxySubscriber(Class eventClass, Object subscribedByProxy) {
+ List subscribers = getVetoSubscribers(eventClass);
+ return getProxySubscriber(subscribers, subscribedByProxy);
+ }
+
+ private ProxySubscriber getVetoProxySubscriber(String topic, Object subscribedByProxy) {
+ List subscribers = getVetoSubscribers(topic);
+ return getProxySubscriber(subscribers, subscribedByProxy);
+ }
+
+ private ProxySubscriber getVetoProxySubscriber(Pattern pattern, Object subscribedByProxy) {
+ List subscribers = getVetoSubscribers(pattern);
+ return getProxySubscriber(subscribers, subscribedByProxy);
+ }
+
+ private ProxySubscriber getProxySubscriber(List subscribers, Object subscribedByProxy) {
+ for (Iterator iter = subscribers.iterator(); iter.hasNext();) {
+ Object subscriber = iter.next();
+ if (subscriber instanceof WeakReference) {
+ WeakReference wr = (WeakReference) subscriber;
+ subscriber = wr.get();
+ }
+ if (subscriber instanceof ProxySubscriber) {
+ ProxySubscriber proxy = (ProxySubscriber) subscriber;
+ subscriber = proxy.getProxiedSubscriber();
+ if (subscriber == subscribedByProxy) {
+ return proxy;
+ }
+ }
+ }
+ return null;
+ }
+
+ /** @see EventService#publish(Object) */
+ public void publish(Object event) {
+ if (event == null) {
+ throw new IllegalArgumentException("Cannot publish null event.");
+ }
+ publish(event, null, null, getSubscribers(event.getClass()), getVetoSubscribers(event.getClass()), null);
+ }
+
+ /** @see EventService#publish(java.lang.reflect.Type, Object) */
+ public void publish(Type genericType, Object event) {
+ if (genericType == null) {
+ throw new IllegalArgumentException("genericType must not be null.");
+ }
+ if (event == null) {
+ throw new IllegalArgumentException("Cannot publish null event.");
+ }
+ publish(event, null, null, getSubscribers(genericType), null/*getVetoSubscribers(genericType)*/, null);
+ }
+
+ /** @see EventService#publish(String,Object) */
+ public void publish(String topicName, Object eventObj) {
+ publish(null, topicName, eventObj, getSubscribers(topicName), getVetoEventListeners(topicName), null);
+ }
+
+ /**
+ * All publish methods call this method. Extending classes only have to override this method to handle all
+ * publishing cases.
+ *
+ * @param event the event to publish, null if publishing on a topic
+ * @param topic if publishing on a topic, the topic to publish on, else null
+ * @param eventObj if publishing on a topic, the eventObj to publish, else null
+ * @param subscribers the subscribers to publish to - must be a snapshot copy
+ * @param vetoSubscribers the veto subscribers to publish to - must be a snapshot copy.
+ * @param callingStack the stack that called this publication, helpful for reporting errors on other threads
+ * @throws IllegalArgumentException if eh or o is null
+ */
+ protected void publish(final Object event, final String topic, final Object eventObj,
+ final List subscribers, final List vetoSubscribers, StackTraceElement[] callingStack) {
+
+ if (event == null && topic == null) {
+ throw new IllegalArgumentException("Can't publish to null topic/event.");
+ }
+
+ setStatus(PublicationStatus.Initiated, event, topic, eventObj);
+ //topic or event
+ logEvent(event, topic, eventObj);
+
+ //Check all veto subscribers, if any veto, then don't publish or cache
+ if (checkVetoSubscribers(event, topic, eventObj, vetoSubscribers, callingStack)) {
+ setStatus(PublicationStatus.Vetoed, event, topic, eventObj);
+ return;
+ } else {
+ setStatus(PublicationStatus.Queued, event, topic, eventObj);
+ }
+
+ addEventToCache(event, topic, eventObj);
+
+ if (subscribers == null || subscribers.isEmpty()) {
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("No subscribers for event or topic. Event:" + event + ", Topic:" + topic);
+ }
+ } else {
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("Publishing to subscribers:" + subscribers);
+ }
+ setStatus(PublicationStatus.Publishing, event, topic, eventObj);
+ for (int i = 0; i < subscribers.size(); i++) {
+ Object eh = subscribers.get(i);
+ if (event != null) {
+ EventSubscriber eventSubscriber = (EventSubscriber) eh;
+ long start = System.currentTimeMillis();
+ try {
+ eventSubscriber.onEvent(event);
+ } catch (Throwable e) {
+ handleException(event, e, callingStack, eventSubscriber);
+ }
+ } else {
+ EventTopicSubscriber eventTopicSubscriber = (EventTopicSubscriber) eh;
+ try {
+ eventTopicSubscriber.onEvent(topic, eventObj);
+ } catch (Throwable e) {
+ onEventException(topic, eventObj, e, callingStack, eventTopicSubscriber);
+ }
+ }
+ }
+ }
+ setStatus(PublicationStatus.Completed, event, topic, eventObj);
+ }
+
+ /**
+ * Called during publication to set the status on an event. Can be used by subclasses
+ * to be notified when an event transitions from one state to another. Implementers
+ * are required to call setPublicationStatus
+ * @param status the status to set on the object
+ * @param event the event being published, will be null if topic is not null
+ * @param topic the topic eventObj is being published on, will be null if event is not null
+ * @param eventObj the payload being published on the topic , will be null if event is not null
+ */
+ @SuppressWarnings({"UnusedDeclaration"})
+ protected void setStatus(PublicationStatus status, Object event, String topic, Object eventObj) {
+ if (event instanceof PublicationStatusTracker) {
+ ((PublicationStatusTracker)event).setPublicationStatus(status);
+ }
+ if (eventObj instanceof PublicationStatusTracker) {
+ ((PublicationStatusTracker)eventObj).setPublicationStatus(status);
+ }
+ }
+
+ /**
+ * Handles subscribers that are Prioritized by putting the most negative prioritized subscribers
+ * first, the most positive prioritized subscribers last, and leaving non-Prioritized in their
+ * original FIFO order.
+ * @param subscribers the subscribers to sort
+ * @return the same list if there are no prioritized subscribers in the list, otherwise a new sorted result
+ */
+ private List sortSubscribers(List subscribers) {
+ if (subscribers == null) {
+ return null;
+ }
+ List prioritizedSubscribers = null;
+ Iterator iterator = subscribers.iterator();
+ while (iterator.hasNext()) {
+ Object subscriber = iterator.next();
+ if (subscriber instanceof Prioritized) {
+ Prioritized prioritized = ((Prioritized)subscriber);
+ if (prioritized.getPriority() != 0) {
+ iterator.remove();
+ if (prioritizedSubscribers == null) {
+ prioritizedSubscribers = new ArrayList();
+ }
+ prioritizedSubscribers.add(prioritized);
+ }
+ }
+ }
+ if (prioritizedSubscribers == null) {
+ return subscribers;
+ } else {
+ List result = new ArrayList(prioritizedSubscribers.size()+subscribers.size());
+ Collections.sort(prioritizedSubscribers, PRIORITIZED_SUBSCRIBER_COMPARATOR);
+ boolean haveAddedFIFOSubscribers = false;
+ for (Prioritized prioritizedSubscriber : prioritizedSubscribers) {
+ if (prioritizedSubscriber.getPriority() > 0 && !haveAddedFIFOSubscribers) {
+ for (Object subscriber : subscribers) {
+ result.add(subscriber);
+ }
+ haveAddedFIFOSubscribers = true;
+ }
+ result.add(prioritizedSubscriber);
+ }
+ //Issue 26 - of all priorities are negative, then add the FIFO after processing all of them
+ if (!haveAddedFIFOSubscribers) {
+ for (Object subscriber : subscribers) {
+ result.add(subscriber);
+ }
+ }
+ return result;
+ }
+ }
+
+ private boolean checkVetoSubscribers(Object event, String topic, Object eventObj, List vetoSubscribers,
+ StackTraceElement[] callingStack) {
+ if (vetoSubscribers != null && !vetoSubscribers.isEmpty()) {
+ for (Iterator vlIter = vetoSubscribers.iterator(); vlIter.hasNext();) {
+ Object vetoer = vlIter.next();
+ VetoEventListener vl = null;
+ VetoTopicEventListener vtl = null;
+ if (event == null) {
+ vtl = (VetoTopicEventListener) vetoer;
+ } else {
+ vl = (VetoEventListener) vetoer;
+ }
+ long start = System.currentTimeMillis();
+ try {
+ boolean shouldVeto = false;
+ if (event == null) {
+ shouldVeto = vtl.shouldVeto(topic, eventObj);
+ } else {
+ shouldVeto = vl.shouldVeto(event);
+ }
+ if (shouldVeto) {
+ handleVeto(vl, event, vtl, topic, eventObj);
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("Publication vetoed. Event:" + event + ", Topic:" + topic + ", veto subscriber:" + vl);
+ }
+ return true;
+ }
+ } catch (Throwable ex) {
+ subscribeVetoException(event, topic, eventObj, ex, callingStack, vl);
+ }
+ }
+ }
+ return false;
+ }
+
+ private void logEvent(Object event, String topic, Object eventObj) {
+ if (LOG.isLoggable(Level.DEBUG)) {
+ if (event != null) {
+ LOG.debug("Publishing event: class=" + event.getClass() + ", event=" + event);
+ } else if (topic != null) {
+ LOG.debug("Publishing event: topic=" + topic + ", eventObj=" + eventObj);
+ }
+ }
+ }
+
+ /**
+ * Adds an event to the event cache, if appropriate. This method is called just before publication to listeners,
+ * after the event passes any veto listeners.
+ *
+ * Using protected visibility to open the caching to other implementations.
+ *
+ *
+ * @param event the event about to be published, null if topic is non-null
+ * @param topic the topic about to be published to, null if the event is non-null
+ * @param eventObj the eventObj about to be published on a topic, null if the event is non-null
+ */
+ protected void addEventToCache(Object event, String topic, Object eventObj) {
+ //Taking the listener lock here, since a listener that is now subscribing will want
+ //this event since they are not in this subscriber list.
+ synchronized (listenerLock) {
+ if (event != null) {
+ int cacheSizeForEventClass = getCacheSizeForEventClass(event.getClass());
+ List eventClassCache = (List) cacheByEvent.get(event.getClass());
+ if (cacheSizeForEventClass <= 0) {
+ if (eventClassCache != null) {
+ //the cache threshold was lowered to 0
+ cacheByEvent.remove(event.getClass());
+ }
+ } else {
+ if (eventClassCache == null) {
+ eventClassCache = new LinkedList();
+ cacheByEvent.put(event.getClass(), eventClassCache);
+ }
+ eventClassCache.add(0, event);
+ while (eventClassCache.size() > cacheSizeForEventClass) {
+ eventClassCache.remove(eventClassCache.size() - 1);
+ }
+ }
+ } else {
+ //topic
+ int cacheSizeForTopic = getCacheSizeForTopic(topic);
+ List topicCache = (List) cacheByTopic.get(topic);
+ if (cacheSizeForTopic <= 0) {
+ if (topicCache != null) {
+ //the cache threshold was lowered to 0
+ topicCache.remove(topic);
+ }
+ } else {
+ if (topicCache == null) {
+ topicCache = new LinkedList();
+ cacheByTopic.put(topic, topicCache);
+ }
+ topicCache.add(0, eventObj);
+ while (topicCache.size() > cacheSizeForTopic) {
+ topicCache.remove(topicCache.size() - 1);
+ }
+ }
+ }
+ }
+ }
+
+ /** @see EventService#getSubscribers(Class) */
+ public List getSubscribers(Class eventClass) {
+ List hierarchyMatches;
+ List exactMatches;
+ synchronized (listenerLock) {
+ hierarchyMatches = getSubscribersToClass(eventClass);
+ exactMatches = getSubscribersToExactClass(eventClass);
+ }
+ List result = new ArrayList();
+ if (exactMatches != null) {
+ result.addAll(exactMatches);
+ }
+ if (hierarchyMatches != null) {
+ result.addAll(hierarchyMatches);
+ }
+ if (hasEverUsedPrioritized) {
+ result = sortSubscribers(result);
+ }
+ return result;
+
+ }
+
+ /** @see EventService#getSubscribersToClass(Class) */
+ public List getSubscribersToClass(Class eventClass) {
+ synchronized (listenerLock) {
+ Map classMap = subscribersByEventClass;
+ List result = getEventOrVetoSubscribersToClass(classMap, eventClass);
+ if (hasEverUsedPrioritized) {
+ result = sortSubscribers(result);
+ }
+ return result;
+ }
+ }
+
+ /** @see EventService#getSubscribersToExactClass(Class) */
+ public List getSubscribersToExactClass(Class eventClass) {
+ synchronized (listenerLock) {
+ return getSubscribers(eventClass, subscribersByExactEventClass);
+ }
+ }
+
+ /** @see EventService#getSubscribers(Type) */
+ public List getSubscribers(Type eventType) {
+ List result;
+ synchronized (listenerLock) {
+ result = getEventOrVetoSubscribersToType(subscribersByEventType, eventType);
+ }
+ if (hasEverUsedPrioritized) {
+ result = sortSubscribers(result);
+ }
+ return result;
+ }
+
+ /** @see EventService#getSubscribers(String) */
+ public List getSubscribers(String topic) {
+ List result = new ArrayList();
+ List exactMatches;
+ List patternMatches;
+ synchronized (listenerLock) {
+ exactMatches = getSubscribersToTopic(topic);
+ patternMatches = getSubscribersByPattern(topic);
+ }
+ if (exactMatches != null) {
+ result.addAll(exactMatches);
+ }
+ if (patternMatches != null) {
+ result.addAll(patternMatches);
+ }
+ if (hasEverUsedPrioritized) {
+ result = sortSubscribers(result);
+ }
+ return result;
+ }
+
+ /** @see EventService#getSubscribersToTopic(String) */
+ public List getSubscribersToTopic(String topic) {
+ synchronized (listenerLock) {
+ return getSubscribers(topic, subscribersByTopic);
+ }
+ }
+
+ /** @see EventService#getSubscribers(Pattern) */
+ public List getSubscribers(Pattern pattern) {
+ synchronized (listenerLock) {
+ return getSubscribers(pattern, subscribersByTopicPattern);
+ }
+ }
+
+ /** @see EventService#getSubscribersByPattern(String) */
+ public List getSubscribersByPattern(String topic) {
+ return getSubscribersByPattern(topic, subscribersByTopicPattern);
+ }
+
+ /** @see EventService#getVetoSubscribers(Class) */
+ public List getVetoSubscribers(Class eventClass) {
+ List result = new ArrayList();
+ List exactMatches;
+ List hierarchyMatches;
+ synchronized (listenerLock) {
+ exactMatches = getVetoSubscribersToClass(eventClass);
+ hierarchyMatches = getVetoSubscribersToExactClass(eventClass);
+ }
+ if (exactMatches != null) {
+ result.addAll(exactMatches);
+ }
+ if (hierarchyMatches != null) {
+ result.addAll(hierarchyMatches);
+ }
+ if (hasEverUsedPrioritized) {
+ result = sortSubscribers(result);
+ }
+ return result;
+ }
+
+ /** @see EventService#getVetoSubscribersToClass(Class) */
+ public List getVetoSubscribersToClass(Class eventClass) {
+ List result;
+ synchronized (listenerLock) {
+ Map classMap = vetoListenersByClass;
+ result = getEventOrVetoSubscribersToClass(classMap, eventClass);
+ }
+ if (hasEverUsedPrioritized) {
+ result = sortSubscribers(result);
+ }
+ return result;
+ }
+
+ /** @see EventService#getVetoSubscribersToExactClass(Class) */
+ public List getVetoSubscribersToExactClass(Class eventClass) {
+ synchronized (listenerLock) {
+ return getSubscribers(eventClass, vetoListenersByExactClass);
+ }
+ }
+
+ /** @see EventService#getVetoEventListeners(String) */
+ public List getVetoEventListeners(String topicOrPattern) {
+ List result = new ArrayList();
+ List exactMatches;
+ List patternMatches;
+ synchronized (listenerLock) {
+ exactMatches = getVetoSubscribersToTopic(topicOrPattern);
+ patternMatches = getVetoSubscribersByPattern(topicOrPattern);
+ }
+ if (exactMatches != null) {
+ result.addAll(exactMatches);
+ }
+ if (patternMatches != null) {
+ result.addAll(patternMatches);
+ }
+ if (hasEverUsedPrioritized) {
+ result = sortSubscribers(result);
+ }
+ return result;
+ }
+
+ /** @see EventService#getVetoSubscribersToTopic(String) */
+ public List getVetoSubscribersToTopic(String topic) {
+ synchronized (listenerLock) {
+ return getSubscribers(topic, vetoListenersByTopic);
+ }
+ }
+
+ /**
+ * Note: this is inconsistent with getSubscribers(String)
+ * @see EventService#getVetoSubscribersToTopic(String)
+ * @deprecated use getVetoSubscribersToTopic instead for direct replacement,
+ * or use getVetoEventListeners to get topic and pattern matchers.
+ * In EventBus 2.0 this name will replace getVetoEventListeners()
+ * and have it's union functionality
+ */
+ public List getVetoSubscribers(String topic) {
+ synchronized (listenerLock) {
+ return getVetoSubscribersToTopic(topic);
+ }
+ }
+
+ /** @see EventService#getVetoSubscribers(Pattern) */
+ public List getVetoSubscribers(Pattern topicPattern) {
+ synchronized (listenerLock) {
+ PatternWrapper patternWrapper = new PatternWrapper(topicPattern);
+ return getSubscribers(patternWrapper, vetoListenersByTopicPattern);
+ }
+ }
+
+ /** @see EventService#getVetoSubscribersByPattern(String) */
+ public List getVetoSubscribersByPattern(String pattern) {
+ return getSubscribersByPattern(pattern, vetoListenersByTopicPattern);
+ }
+
+ /** Used for subscribers and veto subscribers */
+ private List getSubscribersByPattern(String topic, Map subscribersByTopicPattern) {
+ List result = new ArrayList();
+ synchronized (listenerLock) {
+ Set keys = subscribersByTopicPattern.keySet();
+ for (Iterator iterator = keys.iterator(); iterator.hasNext();) {
+ PatternWrapper patternKey = (PatternWrapper) iterator.next();
+ if (patternKey.matches(topic)) {
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("Pattern " + patternKey + " matched topic name " + topic);
+ }
+ Collection subscribers = (Collection) subscribersByTopicPattern.get(patternKey);
+ result.addAll(createCopyOfContentsRemoveWeakRefs(subscribers));
+ }
+ }
+ if (hasEverUsedPrioritized) {
+ result = sortSubscribers(result);
+ }
+ return result;
+ }
+ }
+
+ protected List getSubscribersToPattern(Pattern topicPattern) {
+ synchronized (listenerLock) {
+ PatternWrapper patternWrapper = new PatternWrapper(topicPattern);
+ return getSubscribers(patternWrapper, subscribersByTopicPattern);
+ }
+ }
+
+ private List getSubscribers(Object classOrTopic, Map subscriberMap) {
+ List result;
+ synchronized (listenerLock) {
+ List subscribers = (List) subscriberMap.get(classOrTopic);
+ //Make a defensive copy of subscribers and veto listeners so listeners
+ //can change the listener list while the listeners are being called
+ //Resolve WeakReferences and unsubscribe if necessary.
+ result = createCopyOfContentsRemoveWeakRefs(subscribers);
+ }
+ if (hasEverUsedPrioritized) {
+ result = sortSubscribers(result);
+ }
+ return result;
+ }
+
+ private List getEventOrVetoSubscribersToClass(Map classMap, Class eventClass) {
+ List result = new ArrayList();
+ Set keys = classMap.keySet();
+ for (Iterator iterator = keys.iterator(); iterator.hasNext();) {
+ Class cl = (Class) iterator.next();
+ if (cl.isAssignableFrom(eventClass)) {
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("Hierarchical match " + cl + " matched event of class " + eventClass);
+ }
+ Collection subscribers = (Collection) classMap.get(cl);
+ result.addAll(createCopyOfContentsRemoveWeakRefs(subscribers));
+ }
+ }
+ return result;
+ }
+
+ private List getEventOrVetoSubscribersToType(Map typeMap, Type eventType) {
+ List result = new ArrayList();
+ Set mapKeySet = typeMap.keySet();
+ for (Object mapKey : mapKeySet) {
+ Type subscriberType = (Type) mapKey;
+ if (eventType instanceof ParameterizedType && subscriberType instanceof ParameterizedType) {
+ ParameterizedType subscriberPT = (ParameterizedType) subscriberType;
+ ParameterizedType eventPT = (ParameterizedType) eventType;
+ if (eventPT.getRawType().equals(subscriberPT.getRawType())) {
+ Type[] mapTypeArgs = subscriberPT.getActualTypeArguments();
+ Type[] eventTypeArgs = eventPT.getActualTypeArguments();
+ if (mapTypeArgs == null || eventTypeArgs == null || mapTypeArgs.length != eventTypeArgs.length) {
+ continue;
+ }
+ boolean parameterArgsMatch = true;
+ for (int argCount = 0; argCount < mapTypeArgs.length; argCount++) {
+ Type eventTypeArg = eventTypeArgs[argCount];
+ if (eventTypeArg instanceof WildcardType) {
+ throw new IllegalArgumentException("Only simple Class parameterized types can be published, not wildcards, etc. Published attempt made for:"+eventTypeArg);
+ }
+ Type subscriberTypeArg = mapTypeArgs[argCount];
+ if (subscriberTypeArg instanceof WildcardType) {
+ WildcardType wildcardSubscriberTypeArg = (WildcardType) subscriberTypeArg;
+ Type[] upperBound = wildcardSubscriberTypeArg.getUpperBounds();
+ Type[] lowerBound = wildcardSubscriberTypeArg.getLowerBounds();
+ if (upperBound != null && upperBound.length > 0) {
+ if (upperBound[0] instanceof Class) {
+ Class upper = (Class) upperBound[0];
+ if (eventTypeArg instanceof Class) {
+ if (!upper.isAssignableFrom((Class) eventTypeArg)) {
+ parameterArgsMatch = false;
+ break;
+ }
+ } else {
+ parameterArgsMatch = false;
+ break;
+ }
+ } else {
+ throw new IllegalArgumentException("Only Class and Interface types are supported as types of wildcard subscriptions. Type:"+upperBound[0]);
+ }
+ }
+ if (lowerBound != null && lowerBound.length > 0) {
+ if (lowerBound[0] instanceof Class) {
+ Class lower = (Class) lowerBound[0];
+ if (eventTypeArg instanceof Class) {
+ if (!((Class)eventTypeArg).isAssignableFrom(lower)) {
+ parameterArgsMatch = false;
+ break;
+ }
+ } else {
+ parameterArgsMatch = false;
+ break;
+ }
+ } else {
+ throw new IllegalArgumentException("Only Class and Interface types are supported as types of wildcard subscriptions. Type:"+upperBound[0]);
+ }
+ }
+ } else if (!subscriberTypeArg.equals(eventTypeArg)) {
+ parameterArgsMatch = false;
+ break;
+ }
+ }
+ if (parameterArgsMatch) {
+ if (LOG.isLoggable(Level.DEBUG)) {
+ LOG.debug("Exact parameterized subscriberType match for event subscriberType " + eventType);
+ }
+ Collection subscribers = (Collection) typeMap.get(subscriberType);
+ if (subscribers != null) {
+ result.addAll(createCopyOfContentsRemoveWeakRefs(subscribers));
+ }
+ }
+ }
+ }
+ }
+ return result;
+// Type o = p.getOwnerType();
+// if (o != null) {
+//
+// }
+// p.getActualTypeArguments();
+// }
+ /*
+ } else if (type instanceof TypeVariable) {
+ TypeVariable v = (TypeVariable)type;
+ out.print(v.getName());
+ } else if (type instanceof GenericArrayType) {
+ GenericArrayType a = (GenericArrayType)type;
+ printType(a.getGenericComponentType());
+ out.print("[]");
+ } else if (type instanceof WildcardType) {
+ WildcardType w = (WildcardType)type;
+ Type[] upper = w.getUpperBounds();
+ Type[] lower = w.getLowerBounds();
+ if (upper.length==1 && lower.length==0) {
+ out.print("? extends ");
+ printType(upper[0]);
+ } else if (upper.length==0 && lower.length==1) {
+ out.print("? super ");
+ printType(lower[0]);
+ } else assert false;
+ }
+ */
+ }
+
+ /**
+ * Handle vetos of an event or topic, by default logs finely.
+ *
+ * @param vl the veto listener for an event
+ * @param event the event, can be null if topic is not
+ * @param vtl the veto listener for a topic
+ * @param topic can be null if event is not
+ * @param eventObj the object published with the topic
+ */
+ protected void handleVeto(VetoEventListener vl, Object event,
+ VetoTopicEventListener vtl, String topic, Object eventObj) {
+ if (LOG.isLoggable(Level.DEBUG)) {
+ if (event != null) {
+ LOG.debug("Vetoing event: class=" + event.getClass() + ", event=" + event + ", vetoer:" + vl);
+ } else {
+ LOG.debug("Vetoing event: topic=" + topic + ", eventObj=" + eventObj + ", vetoer:" + vtl);
+ }
+ }
+ }
+
+ /**
+ * Given a Map (of Lists of subscribers or veto listeners), removes the toRemove element from the List in the map for
+ * the given key. The entire map is checked for WeakReferences and ProxySubscribers and they are all unsubscribed
+ * if stale.
+ *
+ * @param map map of lists
+ * @param key key for a List in the map
+ * @param toRemove the object to remove form the list with the key of the map
+ *
+ * @return true if toRemove was unsubscribed
+ */
+ private boolean removeFromSetResolveWeakReferences(Map map, Object key, Object toRemove) {
+ List subscribers = (List) map.get(key);
+ if (subscribers == null) {
+ return false;
+ }
+ if (subscribers.remove(toRemove)) {
+ if (toRemove instanceof WeakReference) {
+ decWeakRefPlusProxySubscriberCount();
+ }
+ if (toRemove instanceof ProxySubscriber) {
+ ((ProxySubscriber)toRemove).proxyUnsubscribed();
+ decWeakRefPlusProxySubscriberCount();
+ }
+ return true;
+ }
+
+ //search for WeakReferences and ProxySubscribers
+ for (Iterator iter = subscribers.iterator(); iter.hasNext();) {
+ Object existingSubscriber = iter.next();
+ if (existingSubscriber instanceof ProxySubscriber) {
+ ProxySubscriber proxy = (ProxySubscriber) existingSubscriber;
+ existingSubscriber = proxy.getProxiedSubscriber();
+ if (existingSubscriber == toRemove) {
+ removeProxySubscriber(proxy, iter);
+ return true;
+ }
+ }
+ if (existingSubscriber instanceof WeakReference) {
+ WeakReference wr = (WeakReference) existingSubscriber;
+ Object realRef = wr.get();
+ if (realRef == null) {
+ //clean up a garbage collected reference
+ iter.remove();
+ decWeakRefPlusProxySubscriberCount();
+ return true;
+ } else if (realRef == toRemove) {
+ iter.remove();
+ decWeakRefPlusProxySubscriberCount();
+ return true;
+ } else if (realRef instanceof ProxySubscriber) {
+ ProxySubscriber proxy = (ProxySubscriber) realRef;
+ existingSubscriber = proxy.getProxiedSubscriber();
+ if (existingSubscriber == toRemove) {
+ removeProxySubscriber(proxy, iter);
+ return true;
+ }
+ }
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Given a set (or subscribers or veto listeners), makes a copy of the set, resolving WeakReferences to hard
+ * references, and removing garbage collected references from the original set.
+ *
+ * @param subscribersOrVetoListeners
+ *
+ * @return a copy of the set
+ */
+ private List createCopyOfContentsRemoveWeakRefs(Collection subscribersOrVetoListeners) {
+ if (subscribersOrVetoListeners == null) {
+ return null;
+ }
+ List copyOfSubscribersOrVetolisteners = new ArrayList(subscribersOrVetoListeners.size());
+ for (Iterator iter = subscribersOrVetoListeners.iterator(); iter.hasNext();) {
+ Object elem = iter.next();
+ if (elem instanceof ProxySubscriber) {
+ ProxySubscriber proxy = (ProxySubscriber)elem;
+ elem = proxy.getProxiedSubscriber();
+ if (elem == null) {
+ removeProxySubscriber(proxy, iter);
+ } else {
+ copyOfSubscribersOrVetolisteners.add(proxy);
+ }
+ } else if (elem instanceof WeakReference) {
+ Object hardRef = ((WeakReference) elem).get();
+ if (hardRef == null) {
+ //Was reclaimed, unsubscribe
+ iter.remove();
+ decWeakRefPlusProxySubscriberCount();
+ } else {
+ copyOfSubscribersOrVetolisteners.add(hardRef);
+ }
+ } else {
+ copyOfSubscribersOrVetolisteners.add(elem);
+ }
+ }
+ return copyOfSubscribersOrVetolisteners;
+ }
+
+ /**
+ * Sets the default cache size for each kind of event, default is 0 (no caching).
+ *
+ * If this value is set to a positive number, then when an event is published, the EventService caches the event or
+ * topic payload data for later retrieval. This allows subscribers to find out what has most recently happened
+ * before they subscribed. The cached event(s) are returned from #getLastEvent(Class), #getLastTopicData(String),
+ * #getCachedEvents(Class), or #getCachedTopicData(String)
+ *
+ *
+ * The default can be overridden on a by-event-class or by-topic basis.
+ *
+ *
+ * @param defaultCacheSizePerClassOrTopic
+ */
+ public void setDefaultCacheSizePerClassOrTopic(int defaultCacheSizePerClassOrTopic) {
+ synchronized (cacheLock) {
+ this.defaultCacheSizePerClassOrTopic = defaultCacheSizePerClassOrTopic;
+ }
+ }
+
+ /** @return the default number of event payloads kept per event class or topic */
+ public int getDefaultCacheSizePerClassOrTopic() {
+ synchronized (cacheLock) {
+ return defaultCacheSizePerClassOrTopic;
+ }
+ }
+
+ /**
+ * Set the number of events cached for a particular class of event. By default, no events are cached.
+ *
+ * This overrides any setting for the DefaultCacheSizePerClassOrTopic.
+ *
+ *
+ * Class hierarchy semantics are respected. That is, if there are three events, A, X and Y, and X and Y are both
+ * derived from A, then setting the cache size for A applies the cache size for all three. Setting the cache size
+ * for X applies to X and leaves the settings for A and Y in tact. Interfaces can be passed to this method, but they
+ * only take effect if the cache size of a class or it's superclasses has been set. Just like Class.getInterfaces(),
+ * if multiple cache sizes are set, the interface names declared earliest in the implements clause of the eventClass
+ * takes effect.
+ *
+ *
+ * The cache for an event is not adjusted until the next event of that class is published.
+ *
+ *
+ * @param eventClass the class of event
+ * @param cacheSize the number of published events to cache for this event
+ */
+ public void setCacheSizeForEventClass(Class eventClass, int cacheSize) {
+ synchronized (cacheLock) {
+ if (rawCacheSizesForEventClass == null) {
+ rawCacheSizesForEventClass = new HashMap();
+ }
+ rawCacheSizesForEventClass.put(eventClass, new Integer(cacheSize));
+ rawCacheSizesForEventClassChanged = true;
+ }
+ }
+
+ /**
+ * Returns the number of events cached for a particular class of event. By default, no events are cached.
+ *
+ * This result is computed for a particular class from the values passed to #setCacheSizeForEventClass(Class, int),
+ * and respects the class hierarchy.
+ *
+ *
+ * @param eventClass the class of event
+ *
+ * @return the maximum size of the event cache for the given event class
+ *
+ * @see #setCacheSizeForEventClass(Class,int)
+ */
+ public int getCacheSizeForEventClass(Class eventClass) {
+ if (eventClass == null) {
+ throw new IllegalArgumentException("eventClass must not be null.");
+ }
+ synchronized (cacheLock) {
+ if (rawCacheSizesForEventClass == null || rawCacheSizesForEventClass.size() == 0) {
+ return getDefaultCacheSizePerClassOrTopic();
+ }
+ if (cacheSizesForEventClass == null) {
+ cacheSizesForEventClass = new HashMap();
+ }
+ if (rawCacheSizesForEventClassChanged) {
+ cacheSizesForEventClass.clear();
+ cacheSizesForEventClass.putAll(rawCacheSizesForEventClass);
+ rawCacheSizesForEventClassChanged = false;
+ }
+
+ //Has this been computed yet or set directly?
+ Integer size = (Integer) cacheSizesForEventClass.get(eventClass);
+ if (size != null) {
+ return size.intValue();
+ } else {
+ //must be computed
+ Class parent = eventClass.getSuperclass();
+ while (parent != null) {
+ Integer parentSize = (Integer) cacheSizesForEventClass.get(parent);
+ if (parentSize != null) {
+ cacheSizesForEventClass.put(eventClass, parentSize);
+ return parentSize.intValue();
+ }
+ parent = parent.getSuperclass();
+ }
+ //try interfaces
+ Class[] interfaces = eventClass.getInterfaces();
+ for (int i = 0; i < interfaces.length; i++) {
+ Class anInterface = interfaces[i];
+ Integer interfaceSize = (Integer) cacheSizesForEventClass.get(anInterface);
+ if (interfaceSize != null) {
+ cacheSizesForEventClass.put(eventClass, interfaceSize);
+ return interfaceSize.intValue();
+ }
+ }
+ }
+ return getDefaultCacheSizePerClassOrTopic();
+ }
+ }
+
+ /**
+ * Set the number of published data objects cached for a particular event topic. By default, no caching is done.
+ *
+ * This overrides any setting for the DefaultCacheSizePerClassOrTopic.
+ *
+ *
+ * Settings for exact topic names take precedence over pattern matching.
+ *
+ *
+ * The cache for a topic is not adjusted until the next publication on that topic.
+ *
+ *
+ * @param topicName the topic name
+ * @param cacheSize the number of published data Objects to cache for this topic
+ */
+ public void setCacheSizeForTopic(String topicName, int cacheSize) {
+ synchronized (cacheLock) {
+ if (rawCacheSizesForTopic == null) {
+ rawCacheSizesForTopic = new HashMap();
+ }
+ rawCacheSizesForTopic.put(topicName, new Integer(cacheSize));
+ rawCacheSizesForTopicChanged = true;
+ }
+ }
+
+ /**
+ * Set the number of published data objects cached for topics matching a pattern. By default, caching is done.
+ *
+ * This overrides any setting for the DefaultCacheSizePerClassOrTopic.
+ *
+ *
+ * Settings for exact topic names take precedence over pattern matching. If a topic matches the cache settings for
+ * more than one pattern, the cache size chosen is an undetermined one from one of the matched pattern settings.
+ *
+ *
+ * The cache for a topic is not adjusted until the next publication on that topic.
+ *
+ *
+ * @param pattern the pattern matching topic names
+ * @param cacheSize the number of data Objects to cache for this topic
+ */
+ public void setCacheSizeForTopic(Pattern pattern, int cacheSize) {
+ synchronized (cacheLock) {
+ if (rawCacheSizesForPattern == null) {
+ rawCacheSizesForPattern = new HashMap();
+ }
+ PatternWrapper patternWrapper = new PatternWrapper(pattern);
+ rawCacheSizesForPattern.put(patternWrapper, new Integer(cacheSize));
+ rawCacheSizesForPatternChanged = true;
+ }
+ }
+
+ /**
+ * Returns the number of cached data objects published on a particular topic. By default, no caching is performed.
+ *
+ * This result is computed for a particular topic from the values passed to #setCacheSizeForTopic(String, int) and
+ * #setCacheSizeForTopic(Pattern, int).
+ *
+ *
+ * @param topic the topic name
+ *
+ * @return the maximum size of the data Object cache for the given topic
+ *
+ * @see #setCacheSizeForTopic(String,int)
+ * @see #setCacheSizeForTopic(java.util.regex.Pattern,int)
+ */
+ public int getCacheSizeForTopic(String topic) {
+ if (topic == null) {
+ throw new IllegalArgumentException("topic must not be null.");
+ }
+ synchronized (cacheLock) {
+ if ((rawCacheSizesForTopic == null || (rawCacheSizesForTopic != null && rawCacheSizesForTopic.size() == 0)) &&
+ (rawCacheSizesForPattern == null || (rawCacheSizesForPattern != null && rawCacheSizesForPattern.size() == 0))) {
+ return getDefaultCacheSizePerClassOrTopic();
+ }
+ if (cacheSizesForTopic == null) {
+ cacheSizesForTopic = new HashMap();
+ }
+ if (rawCacheSizesForTopicChanged || rawCacheSizesForPatternChanged) {
+ cacheSizesForTopic.clear();
+ cacheSizesForTopic.putAll(rawCacheSizesForTopic);
+ rawCacheSizesForTopicChanged = false;
+ rawCacheSizesForPatternChanged = false;
+ }
+
+ //Is this an exact match or has it been matched to a pattern yet?
+ Integer size = cacheSizesForTopic.get(topic);
+ if (size != null) {
+ return size;
+ } else {
+ //try matching patterns
+ if (rawCacheSizesForPattern != null) {
+ Set patterns = rawCacheSizesForPattern.keySet();
+ for (Iterator iterator = patterns.iterator(); iterator.hasNext();) {
+ PatternWrapper pattern = (PatternWrapper) iterator.next();
+ if (pattern.matches(topic)) {
+ size = rawCacheSizesForPattern.get(pattern);
+ cacheSizesForTopic.put(topic, size);
+ return size;
+ }
+ }
+ }
+ }
+ return getDefaultCacheSizePerClassOrTopic();
+ }
+ }
+
+ /**
+ * @param eventClass an index into the cache, cannot be an interface
+ *
+ * @return the last event published for this event class, or null if caching is turned off (the default)
+ */
+ public Object getLastEvent(Class eventClass) {
+ if (eventClass.isInterface()) {
+ throw new IllegalArgumentException("Interfaces are not accepted in get last event, use a specific event class.");
+ }
+ synchronized (cacheLock) {
+ List eventCache = cacheByEvent.get(eventClass);
+ if (eventCache == null || eventCache.size() == 0) {
+ return null;
+ }
+ return eventCache.get(0);
+ }
+ }
+
+ /**
+ * @param eventClass an index into the cache, cannot be an interface
+ *
+ * @return the last events published for this event class, or null if caching is turned off (the default)
+ */
+ public List getCachedEvents(Class eventClass) {
+ if (eventClass.isInterface()) {
+ throw new IllegalArgumentException("Interfaces are not accepted in get last event, use a specific event class.");
+ }
+ synchronized (cacheLock) {
+ List eventCache = cacheByEvent.get(eventClass);
+ if (eventCache == null || eventCache.size() == 0) {
+ return null;
+ }
+ return eventCache;
+ }
+ }
+
+ /**
+ * @param topic an index into the cache
+ *
+ * @return the last data Object published on this topic, or null if caching is turned off (the default)
+ */
+ public Object getLastTopicData(String topic) {
+ synchronized (cacheLock) {
+ List topicCache = cacheByTopic.get(topic);
+ if (topicCache == null || topicCache.size() == 0) {
+ return null;
+ }
+ return topicCache.get(0);
+ }
+ }
+
+ /**
+ * @param topic an index into the cache
+ *
+ * @return the last data Objects published on this topic, or null if caching is turned off (the default)
+ */
+ public List getCachedTopicData(String topic) {
+ synchronized (cacheLock) {
+ List topicCache = cacheByTopic.get(topic);
+ if (topicCache == null || topicCache.size() == 0) {
+ return null;
+ }
+ return topicCache;
+ }
+ }
+
+ /**
+ * Clears the event cache for a specific event class or interface and it's any of it's subclasses or implementing
+ * classes.
+ *
+ * @param eventClassToClear the event class to clear the cache for
+ */
+ public void clearCache(Class eventClassToClear) {
+ synchronized (cacheLock) {
+ Set classes = cacheByEvent.keySet();
+ for (Iterator iterator = classes.iterator(); iterator.hasNext();) {
+ Class cachedClass = (Class) iterator.next();
+ if (eventClassToClear.isAssignableFrom(cachedClass)) {
+ iterator.remove();
+ }
+ }
+ }
+ }
+
+ /**
+ * Clears the topic data cache for a specific topic name.
+ *
+ * @param topic the topic name to clear the cache for
+ */
+ public void clearCache(String topic) {
+ synchronized (cacheLock) {
+ cacheByTopic.remove(topic);
+ }
+ }
+
+ /**
+ * Clears the topic data cache for all topics that match a particular pattern.
+ *
+ * @param pattern the pattern to match topic caches to
+ */
+ public void clearCache(Pattern pattern) {
+ synchronized (cacheLock) {
+ Set classes = cacheByTopic.keySet();
+ for (Iterator iterator = classes.iterator(); iterator.hasNext();) {
+ String cachedTopic = (String) iterator.next();
+ if (pattern.matcher(cachedTopic).matches()) {
+ iterator.remove();
+ }
+ }
+ }
+ }
+
+ /** Clear all event caches for all topics and event. */
+ public void clearCache() {
+ synchronized (cacheLock) {
+ cacheByEvent.clear();
+ cacheByTopic.clear();
+ }
+ }
+
+ /** Called during veto exceptions, calls handleException */
+ protected void subscribeVetoException(final Object event, final String topic, final Object eventObj,
+ Throwable e, StackTraceElement[] callingStack, VetoEventListener vetoer) {
+ String str = "EventService veto event listener r:" + vetoer;
+ if (vetoer != null) {
+ str = str + ". Vetoer class:" + vetoer.getClass();
+ }
+ handleException("vetoing", event, topic, eventObj, e, callingStack, str);
+ }
+
+ /** Called during event handling exceptions, calls handleException */
+ protected void onEventException(final String topic, final Object eventObj, Throwable e,
+ StackTraceElement[] callingStack, EventTopicSubscriber eventTopicSubscriber) {
+ String str = "EventService topic subscriber:" + eventTopicSubscriber;
+ if (eventTopicSubscriber != null) {
+ str = str + ". Subscriber class:" + eventTopicSubscriber.getClass();
+ }
+ handleException("handling event", null, topic, eventObj, e, callingStack, str);
+ }
+
+ /** Called during event handling exceptions, calls handleException */
+ protected void handleException(final Object event, Throwable e,
+ StackTraceElement[] callingStack, EventSubscriber eventSubscriber) {
+ String str = "EventService subscriber:" + eventSubscriber;
+ if (eventSubscriber != null) {
+ str = str + ". Subscriber class:" + eventSubscriber.getClass();
+ }
+ handleException("handling event topic", event, null, null, e, callingStack, str);
+ }
+
+ /**
+ * All exception handling goes through this method. Logs a warning by default.
+ */
+ protected void handleException(final String action, final Object event, final String topic,
+ final Object eventObj, Throwable e, StackTraceElement[] callingStack, String sourceString) {
+ String eventClassString = (event == null ? "none" : event.getClass().getName());
+ String eventString = event + "";
+ String contextMsg = "Exception " + action + " event class=" + eventClassString
+ + ", event=" + eventString + ", topic=" + topic + ", eventObj=" + eventObj;
+ SwingException clientEx = new SwingException(contextMsg, e, callingStack);
+ String msg = "Exception thrown by;" + sourceString;
+ LOG.log(Level.WARN, msg, clientEx);
+ }
+
+ /**
+ * Unsubscribe a subscriber if it is a stale ProxySubscriber. Used during subscribe() and
+ * in the cleanup Timer. See the class javadoc.
+ *
+ * Not private since I don't claim I'm smart enough to anticipate all needs, but I
+ * am smart enough to doc the rules you must follow to override this method. Those
+ * rules may change (changes will be doc'ed), override at your own risk.
+ *
+ *
+ * Overriders MUST call iterator.remove() to unsubscribe the proxy if the subscriber is
+ * a ProxySubscriber and is stale and should be cleaned up. If the ProxySubscriber
+ * is unsubscribed, then implementers MUST also call proxyUnsubscribed() on the subscriber.
+ * Overriders MUST also remove the proxy from the weakProxySubscriber list by calling
+ * removeStaleProxyFromList. Method assumes caller is holding the listenerList
+ * lock (else how can you pass the iterator?).
+ *
+ * @param iterator current iterator
+ * @param existingSubscriber the current value of the iterator
+ * @return the real value of the param, or the proxied subscriber of the param if
+ * the param is a a ProxySubscriber
+ */
+ protected Object getRealSubscriberAndCleanStaleSubscriberIfNecessary(Iterator iterator, Object existingSubscriber) {
+ ProxySubscriber existingProxySubscriber = null;
+ if (existingSubscriber instanceof WeakReference) {
+ existingSubscriber = ((WeakReference) existingSubscriber).get();
+ if (existingSubscriber == null) {
+ iterator.remove();
+ decWeakRefPlusProxySubscriberCount();
+ }
+ }
+ if (existingSubscriber instanceof ProxySubscriber) {
+ existingProxySubscriber = (ProxySubscriber) existingSubscriber;
+ existingSubscriber = existingProxySubscriber.getProxiedSubscriber();
+ if (existingProxySubscriber == null) {
+ removeProxySubscriber(existingProxySubscriber, iterator);
+ }
+ }
+ return existingSubscriber;
+ }
+
+ protected void removeProxySubscriber(ProxySubscriber proxy, Iterator iter) {
+ iter.remove();
+ proxy.proxyUnsubscribed();
+ decWeakRefPlusProxySubscriberCount();
+ }
+
+ /**
+ * Increment the count of stale proxies and start a cleanup task if necessary
+ */
+ protected void incWeakRefPlusProxySubscriberCount() {
+ synchronized(listenerLock) {
+ weakRefPlusProxySubscriberCount++;
+ if (cleanupStartThreshhold == null || cleanupPeriodMS == null) {
+ return;
+ }
+ if (weakRefPlusProxySubscriberCount >= cleanupStartThreshhold) {
+ startCleanup();
+ }
+ }
+ }
+
+ /**
+ * Decrement the count of stale proxies
+ */
+ protected void decWeakRefPlusProxySubscriberCount() {
+ synchronized(listenerLock) {
+ weakRefPlusProxySubscriberCount--;
+ if (weakRefPlusProxySubscriberCount < 0) {
+ weakRefPlusProxySubscriberCount = 0;
+ }
+ }
+ }
+
+ private void startCleanup() {
+ synchronized(listenerLock) {
+ if (cleanupTimer == null) {
+ cleanupTimer = new Timer(true);
+ }
+ if (cleanupTimerTask == null) {
+ cleanupTimerTask = new CleanupTimerTask();
+ cleanupTimer.schedule(cleanupTimerTask, 0L, cleanupPeriodMS);
+ }
+ }
+ }
+
+ class CleanupTimerTask extends TimerTask {
+ @Override
+ public void run() {
+ synchronized(listenerLock) {
+ if (weakRefPlusProxySubscriberCount <= cleanupStopThreshold) {
+ this.cancel();
+ cleanupTimer = null;
+ cleanupTimerTask = null;
+ LOG.debug("Cancelled scheduled weak reference and proxy cleanup.");
+ return;
+ }
+ LOG.debug("Starting a weak reference and proxy cleanup.");
+ List allSubscriberMaps = new ArrayList();
+ allSubscriberMaps.add(subscribersByEventType);
+ allSubscriberMaps.add(subscribersByEventClass);
+ allSubscriberMaps.add(subscribersByExactEventClass);
+ allSubscriberMaps.add(subscribersByTopic);
+ allSubscriberMaps.add(subscribersByTopicPattern);
+ allSubscriberMaps.add(vetoListenersByClass);
+ allSubscriberMaps.add(vetoListenersByExactClass);
+ allSubscriberMaps.add(vetoListenersByTopic);
+ allSubscriberMaps.add(vetoListenersByTopicPattern);
+
+ int staleCount = 0;
+ for (Map subscriberMap : allSubscriberMaps) {
+ Set subscriptions = subscriberMap.keySet();
+ for (Object subscription : subscriptions) {
+ List subscribers = (List) subscriberMap.get(subscription);
+ for (Iterator iter = subscribers.iterator(); iter.hasNext();) {
+ Object subscriber = iter.next();
+ Object realSubscriber = getRealSubscriberAndCleanStaleSubscriberIfNecessary(iter, subscriber);
+ if (realSubscriber == null) {
+ staleCount++;
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+
+ private static class PrioritizedSubscriberComparator implements Comparator {
+ public int compare(Prioritized prioritized1, Prioritized prioritized2) {
+ if (prioritized1 == null) {
+ return -1;
+ }
+ if (prioritized2 == null) {
+ return 1;
+ }
+ if (prioritized1.getPriority() < prioritized2.getPriority()) {
+ return -1;
+ } else if (prioritized1.getPriority() > prioritized2.getPriority()) {
+ return 1;
+ } else {
+ return 0;
+ }
+ }
+ }
+
+ /**
+ * Since Pattern doesn't implement equals(), we need one of these
+ */
+ private class PatternWrapper {
+ private Pattern pattern;
+
+ public PatternWrapper(Pattern pat) {
+ pattern = pat;
+ }
+
+ public boolean matches(CharSequence input) {
+ return pattern.matcher(input).matches();
+ }
+
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }
+
+ PatternWrapper that = (PatternWrapper) o;
+
+ if (pattern != null) {
+ if (!pattern.equals(that.pattern)) {//give the JVM a shot for forward compatibility
+ return pattern.pattern() != null && this.pattern.pattern().equals(this.pattern.pattern());
+ }
+ } else {
+ if (that.pattern != null) {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ public int hashCode() {
+ if (this.pattern != null && this.pattern.pattern() != null) {
+ return this.pattern.pattern().hashCode();
+ }
+ return (pattern != null ? pattern.hashCode() : 0);
+ }
+ }
+}
diff --git a/src/main/java/org/scijava/event/bushe/TypeReference.java b/src/main/java/org/scijava/event/bushe/TypeReference.java
new file mode 100644
index 000000000..06ff73a8c
--- /dev/null
+++ b/src/main/java/org/scijava/event/bushe/TypeReference.java
@@ -0,0 +1,52 @@
+package org.scijava.event.bushe;
+
+import java.lang.reflect.Type;
+import java.lang.reflect.Constructor;
+import java.lang.reflect.ParameterizedType;
+import java.lang.reflect.InvocationTargetException;
+
+/**
+ * Courtesy of Neil Gafter's blog.
+ * Thanks to Curt Cox for the pointer.
+ */
+abstract class TypeReference {
+
+ private final Type type;
+ private volatile Constructor constructor;
+
+ protected TypeReference() {
+ Type superclass = getClass().getGenericSuperclass();
+ if (superclass instanceof Class) {
+ throw new RuntimeException("Missing type parameter.");
+ }
+ this.type = ((ParameterizedType) superclass).getActualTypeArguments()[0];
+ }
+
+ /**
+ * @return a new instance of {@code T} using the default, no-arg
+ * constructor.
+ * @throws IllegalAccessException on security reflection issues
+ * @throws NoSuchMethodException there's not getRawType on the type
+ * @throws java.lang.reflect.InvocationTargetException if a reflective call causes an exception in the underlying instance
+ * @throws InstantiationException if the instance cannot be instantiated
+ */
+ @SuppressWarnings("unchecked")
+ public T newInstance()
+ throws NoSuchMethodException, IllegalAccessException,
+ InvocationTargetException, InstantiationException {
+ if (constructor == null) {
+ Class rawType = type instanceof Class
+ ? (Class) type
+ : (Class) ((ParameterizedType) type).getRawType();
+ constructor = rawType.getConstructor();
+ }
+ return (T) constructor.newInstance();
+ }
+
+ /**
+ * @return the referenced type.
+ */
+ public Type getType() {
+ return this.type;
+ }
+}
diff --git a/src/main/java/org/scijava/event/bushe/VetoEventListener.java b/src/main/java/org/scijava/event/bushe/VetoEventListener.java
new file mode 100644
index 000000000..4b377c1c1
--- /dev/null
+++ b/src/main/java/org/scijava/event/bushe/VetoEventListener.java
@@ -0,0 +1,39 @@
+/**
+ * Copyright 2005 Bushe Enterprises, Inc., Hopkinton, MA, USA, www.bushe.com
+ *
+ * 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.scijava.event.bushe;
+
+/**
+ * Interface for classes that can veto class-based event publication from the {@link EventService}.
+ *
+ * @author Michael Bushe michael@bushe.com
+ */
+interface VetoEventListener {
+
+ /**
+ * Determine whether an event should be vetoed or published.
+ *
+ * The EventService calls this method before class-based publication of objects. If any of the
+ * VetoEventListeners return true, then none of the subscribers for that event are called.
Prerequisite:
+ * VetoEventListener has to be subscribed with the EventService for the event object's class.
Guaranteed to be
+ * called in the SwingEventThread when using the SwingEventService (EventBus). See {@link EventService}
+ *
+ *
+ * @param event The event object to veto or allow to be published.
+ *
+ * @return true if the event should be vetoed and not published, false if the event should be published.
+ */
+ public boolean shouldVeto(T event);
+}
diff --git a/src/main/java/org/scijava/event/bushe/VetoTopicEventListener.java b/src/main/java/org/scijava/event/bushe/VetoTopicEventListener.java
new file mode 100644
index 000000000..f44d9693a
--- /dev/null
+++ b/src/main/java/org/scijava/event/bushe/VetoTopicEventListener.java
@@ -0,0 +1,26 @@
+package org.scijava.event.bushe;
+
+/**
+ * Interface for classes that can veto publication on topic names from the {@link org.scijava.event.bushe.EventService}.
+ *
+ * @author Michael Bushe michael@bushe.com
+ */
+interface VetoTopicEventListener {
+
+ /**
+ * Determine whether a topic publication should be vetoed or allowed.
+ *
+ * The EventService calls this method before publication of on a topic name. If any of the
+ * VetoTopicEventListeners return true, then none of the subscribers to that topic are called.
Prerequisite:
+ * VetoTopicEventListener has to be subscribed with the EventService for the topic name.
Guaranteed to be
+ * called in the SwingEventThread when using the SwingEventService (EventBus). See {@link EventService}
+ *
+ *
+ * @param topic The topic name the data object is published on.
+ * @param data The data object being published on the topic.
+ *
+ * @return true if the publication on the topic should be vetoed and not published, false if the data should be
+ * published on the topic.
+ */
+ public boolean shouldVeto(String topic, T data);
+}
diff --git a/src/main/java/org/scijava/input/Accelerator.java b/src/main/java/org/scijava/input/Accelerator.java
index 4615ffd21..73878ca15 100644
--- a/src/main/java/org/scijava/input/Accelerator.java
+++ b/src/main/java/org/scijava/input/Accelerator.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/input/DefaultInputService.java b/src/main/java/org/scijava/input/DefaultInputService.java
index b31364f48..392dc250d 100644
--- a/src/main/java/org/scijava/input/DefaultInputService.java
+++ b/src/main/java/org/scijava/input/DefaultInputService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/input/InputModifiers.java b/src/main/java/org/scijava/input/InputModifiers.java
index 51dca592c..50dba7820 100644
--- a/src/main/java/org/scijava/input/InputModifiers.java
+++ b/src/main/java/org/scijava/input/InputModifiers.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/input/InputService.java b/src/main/java/org/scijava/input/InputService.java
index 5966c06d7..0c7adae95 100644
--- a/src/main/java/org/scijava/input/InputService.java
+++ b/src/main/java/org/scijava/input/InputService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/input/KeyCode.java b/src/main/java/org/scijava/input/KeyCode.java
index e09a75dd5..a8eeccaad 100644
--- a/src/main/java/org/scijava/input/KeyCode.java
+++ b/src/main/java/org/scijava/input/KeyCode.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -52,7 +52,7 @@ public enum KeyCode {
CANCEL(0x03),
/** Clear. */
- CLEAR(0x0C),
+ CLEAR(0x0c),
/** Shift (left or right). */
SHIFT(0x10),
@@ -70,7 +70,7 @@ public enum KeyCode {
CAPS_LOCK(0x14),
/** Escape. */
- ESCAPE(0x1B),
+ ESCAPE(0x1b),
/** Space (' '). */
SPACE(0x20),
@@ -100,16 +100,16 @@ public enum KeyCode {
DOWN(0x28),
/** Comma (','). */
- COMMA(0x2C),
+ COMMA(0x2c),
/** Minus ('-'). */
- MINUS(0x2D),
+ MINUS(0x2d),
/** Period ('.'). */
- PERIOD(0x2E),
+ PERIOD(0x2e),
/** Forward slash ('/'). */
- SLASH(0x2F),
+ SLASH(0x2f),
/** Zero ('0', non-numpad). */
NUM0(0x30),
@@ -142,10 +142,10 @@ public enum KeyCode {
NUM9(0x39),
/** Semicolon (';'). */
- SEMICOLON(0x3B),
+ SEMICOLON(0x3b),
/** Equals ('='). */
- EQUALS(0x3D),
+ EQUALS(0x3d),
/** The letter A. */
A(0x41),
@@ -175,22 +175,22 @@ public enum KeyCode {
I(0x49),
/** The letter J. */
- J(0x4A),
+ J(0x4a),
/** The letter K. */
- K(0x4B),
+ K(0x4b),
/** The letter L. */
- L(0x4C),
+ L(0x4c),
/** The letter M. */
- M(0x4D),
+ M(0x4d),
/** The letter N. */
- N(0x4E),
+ N(0x4e),
/** The letter O. */
- O(0x4F),
+ O(0x4f),
/** The letter P. */
P(0x50),
@@ -223,16 +223,16 @@ public enum KeyCode {
Y(0x59),
/** The letter Z. */
- Z(0x5A),
+ Z(0x5a),
/** Left bracket ('['). */
- OPEN_BRACKET(0x5B),
+ OPEN_BRACKET(0x5b),
/** Backslash ('\\'). */
- BACK_SLASH(0x5C),
+ BACK_SLASH(0x5c),
/** Right bracket (']'). */
- CLOSE_BRACKET(0x5D),
+ CLOSE_BRACKET(0x5d),
/** Zero ('0') on numeric keypad. */
NUMPAD_0(0x60),
@@ -265,24 +265,24 @@ public enum KeyCode {
NUMPAD_9(0x69),
/** Asterisk ('*') on numeric keypad. */
- NUMPAD_ASTERISK(0x6A),
+ NUMPAD_ASTERISK(0x6a),
/** Plus ('+') on numeric keypad. */
- NUMPAD_PLUS(0x6B),
+ NUMPAD_PLUS(0x6b),
- NUMPAD_SEPARATOR(0x6C),
+ NUMPAD_SEPARATOR(0x6c),
/** Minus ('-') on numeric keypad. */
- NUMPAD_MINUS(0x6D),
+ NUMPAD_MINUS(0x6d),
/** Period ('.') on numeric keypad. */
- NUMPAD_PERIOD(0x6E),
+ NUMPAD_PERIOD(0x6e),
/** Slash ('/') on numeric keypad. */
- NUMPAD_SLASH(0x6F),
+ NUMPAD_SLASH(0x6f),
/** Delete (non-numpad). */
- DELETE(0x7F),
+ DELETE(0x7f),
/** Num Lock. */
NUM_LOCK(0x90),
@@ -321,76 +321,76 @@ public enum KeyCode {
F10(0x79),
/** F11. */
- F11(0x7A),
+ F11(0x7a),
/** F12. */
- F12(0x7B),
+ F12(0x7b),
/** F13. */
- F13(0xF000),
+ F13(0xf000),
/** F14. */
- F14(0xF001),
+ F14(0xf001),
/** F15. */
- F15(0xF002),
+ F15(0xf002),
/** F16. */
- F16(0xF003),
+ F16(0xf003),
/** F17. */
- F17(0xF004),
+ F17(0xf004),
/** F18 */
- F18(0xF005),
+ F18(0xf005),
/** F19. */
- F19(0xF006),
+ F19(0xf006),
/** F20. */
- F20(0xF007),
+ F20(0xf007),
/** F21. */
- F21(0xF008),
+ F21(0xf008),
/** F22. */
- F22(0xF009),
+ F22(0xf009),
/** F23. */
- F23(0xF00A),
+ F23(0xf00a),
/** F24. */
- F24(0xF00B),
+ F24(0xf00b),
/** Print Screen. */
- PRINTSCREEN(0x9A),
+ PRINTSCREEN(0x9a),
/** Insert. */
- INSERT(0x9B),
+ INSERT(0x9b),
/** Help. */
- HELP(0x9C),
+ HELP(0x9c),
/** Meta. */
- META(0x9D),
+ META(0x9d),
/** Backquote ('`'). */
- BACK_QUOTE(0xC0),
+ BACK_QUOTE(0xc0),
/** Single quote ('\''). */
- QUOTE(0xDE),
+ QUOTE(0xde),
/** Up arrow on numeric keypad. */
- KP_UP(0xE0),
+ KP_UP(0xe0),
/** Down arrow on numeric keypad. */
- KP_DOWN(0xE1),
+ KP_DOWN(0xe1),
/** Left arrow on numeric keypad. */
- KP_LEFT(0xE2),
+ KP_LEFT(0xe2),
/** Right arrow on numeric keypad. */
- KP_RIGHT(0xE3),
+ KP_RIGHT(0xe3),
/** TODO. */
DEAD_GRAVE(0x80),
@@ -492,51 +492,51 @@ public enum KeyCode {
PLUS(0x0209),
/** Right parenthesis (')'). */
- RIGHT_PARENTHESIS(0x020A),
+ RIGHT_PARENTHESIS(0x020a),
/** Underscore ('_'). */
- UNDERSCORE(0x020B),
+ UNDERSCORE(0x020b),
/** Windows key (both left and right). */
- WINDOWS(0x020C),
+ WINDOWS(0x020c),
/** Windows Context Menu key. */
- CONTEXT_MENU(0x020D),
+ CONTEXT_MENU(0x020d),
FINAL(0x0018),
/** Convert function key. */
- CONVERT(0x001C),
+ CONVERT(0x001c),
/** Don't Convert function key. */
- NONCONVERT(0x001D),
+ NONCONVERT(0x001d),
/** Accept or Commit function key. */
- ACCEPT(0x001E),
+ ACCEPT(0x001e),
- MODECHANGE(0x001F),
+ MODECHANGE(0x001f),
KANA(0x0015),
KANJI(0x0019),
/** Alphanumeric function key. */
- ALPHANUMERIC(0x00F0),
+ ALPHANUMERIC(0x00f0),
/** Katakana function key. */
- KATAKANA(0x00F1),
+ KATAKANA(0x00f1),
/** Hiragana function key. */
- HIRAGANA(0x00F2),
+ HIRAGANA(0x00f2),
/** Full-Width Characters function key. */
- FULL_WIDTH(0x00F3),
+ FULL_WIDTH(0x00f3),
/** Half-Width Characters function key. */
- HALF_WIDTH(0x00F4),
+ HALF_WIDTH(0x00f4),
/** Roman Characters function key. */
- ROMAN_CHARACTERS(0x00F5),
+ ROMAN_CHARACTERS(0x00f5),
/** All Candidates function key. */
ALL_CANDIDATES(0x0100),
@@ -563,37 +563,37 @@ public enum KeyCode {
INPUT_METHOD_ON_OFF(0x0107),
/** Cut (Sun keyboard). */
- CUT(0xFFD1),
+ CUT(0xffd1),
/** Copy (Sun keyboard). */
- COPY(0xFFCD),
+ COPY(0xffcd),
/** Paste (Sun keyboard). */
- PASTE(0xFFCF),
+ PASTE(0xffcf),
/** Undo (Sun keyboard). */
- UNDO(0xFFCB),
+ UNDO(0xffcb),
/** Again (Sun keyboard). */
- AGAIN(0xFFC9),
+ AGAIN(0xffc9),
/** Find (Sun keyboard). */
- FIND(0xFFD0),
+ FIND(0xffd0),
/** Props (Sun keyboard). */
- PROPS(0xFFCA),
+ PROPS(0xffca),
/** Stop (Sun keyboard). */
- STOP(0xFFC8),
+ STOP(0xffc8),
/** Compose function key. */
- COMPOSE(0xFF20),
+ COMPOSE(0xff20),
/** AltGraph function key. */
- ALT_GRAPH(0xFF7E),
+ ALT_GRAPH(0xff7e),
/** Begin key. */
- BEGIN(0xFF58),
+ BEGIN(0xff58),
/** Unknown code. */
UNDEFINED(0x0);
@@ -632,14 +632,97 @@ public static KeyCode get(final int code) {
return keyCode;
}
+ /**
+ * Gets the KeyCode corresponding to the given character,
+ * or {@link #UNDEFINED} if no such code.
+ */
+ public static KeyCode get(final char c) {
+ switch (c) {
+ case '\n': case '\r': return ENTER;
+ case '\b': return BACK_SPACE;
+ case '\t': return TAB;
+ case 0x1b: return ESCAPE;
+ case ' ': return SPACE;
+ case ',': return COMMA;
+ case '-': return MINUS;
+ case '.': return PERIOD;
+ case '/': return SLASH;
+ case '0': return NUM0;
+ case '1': return NUM1;
+ case '2': return NUM2;
+ case '3': return NUM3;
+ case '4': return NUM4;
+ case '5': return NUM5;
+ case '6': return NUM6;
+ case '7': return NUM7;
+ case '8': return NUM8;
+ case '9': return NUM9;
+ case ';': return SEMICOLON;
+ case '=': return EQUALS;
+ case 'a': case 'A': return A;
+ case 'b': case 'B': return B;
+ case 'c': case 'C': return C;
+ case 'd': case 'D': return D;
+ case 'e': case 'E': return E;
+ case 'f': case 'F': return F;
+ case 'g': case 'G': return G;
+ case 'h': case 'H': return H;
+ case 'i': case 'I': return I;
+ case 'j': case 'J': return J;
+ case 'k': case 'K': return K;
+ case 'l': case 'L': return L;
+ case 'm': case 'M': return M;
+ case 'n': case 'N': return N;
+ case 'o': case 'O': return O;
+ case 'p': case 'P': return P;
+ case 'q': case 'Q': return Q;
+ case 'r': case 'R': return R;
+ case 's': case 'S': return S;
+ case 't': case 'T': return T;
+ case 'u': case 'U': return U;
+ case 'v': case 'V': return V;
+ case 'w': case 'W': return W;
+ case 'x': case 'X': return X;
+ case 'y': case 'Y': return Y;
+ case 'z': case 'Z': return Z;
+ case '[': return OPEN_BRACKET;
+ case '\\': return BACK_SLASH;
+ case ']': return CLOSE_BRACKET;
+ case '`': return BACK_QUOTE;
+ case '\'': return QUOTE;
+ case '&': return AMPERSAND;
+ case '*': return ASTERISK;
+ case '"': return QUOTEDBL;
+ case '<': return LESS;
+ case '>': return GREATER;
+ case '{': return BRACELEFT;
+ case '}': return BRACERIGHT;
+ case '@': return AT;
+ case ':': return COLON;
+ case '^': return CIRCUMFLEX;
+ case '$': return DOLLAR;
+ case '€': return EURO_SIGN;
+ case '!': return EXCLAMATION_MARK;
+ case 161: return INVERTED_EXCLAMATION_MARK;
+ case '(': return LEFT_PARENTHESIS;
+ case '#': return NUMBER_SIGN;
+ case '+': return PLUS;
+ case ')': return RIGHT_PARENTHESIS;
+ case '_': return UNDERSCORE;
+ }
+ return UNDEFINED;
+ }
+
/**
* Gets the KeyCode with the given name, or {@link #UNDEFINED} if no such
* code.
*/
public static KeyCode get(final String name) {
final KeyCode keyCode = NAMES.get(name);
- if (keyCode == null) return UNDEFINED;
- return keyCode;
+ if (keyCode != null) return keyCode;
+ // Not a code name, but maybe a direct character value?
+ if (name.length() == 1) return KeyCode.get(name.charAt(0));
+ return UNDEFINED;
}
}
diff --git a/src/main/java/org/scijava/input/MouseCursor.java b/src/main/java/org/scijava/input/MouseCursor.java
index e04d7d9da..15bb0ccc8 100644
--- a/src/main/java/org/scijava/input/MouseCursor.java
+++ b/src/main/java/org/scijava/input/MouseCursor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/AbstractIOPlugin.java b/src/main/java/org/scijava/io/AbstractIOPlugin.java
index 787879832..3c965739a 100644
--- a/src/main/java/org/scijava/io/AbstractIOPlugin.java
+++ b/src/main/java/org/scijava/io/AbstractIOPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/AbstractTypedIOService.java b/src/main/java/org/scijava/io/AbstractTypedIOService.java
index 4ca97bd1b..4d75bfb3e 100644
--- a/src/main/java/org/scijava/io/AbstractTypedIOService.java
+++ b/src/main/java/org/scijava/io/AbstractTypedIOService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/ByteArrayByteBank.java b/src/main/java/org/scijava/io/ByteArrayByteBank.java
index e3b833405..f0183f2d8 100644
--- a/src/main/java/org/scijava/io/ByteArrayByteBank.java
+++ b/src/main/java/org/scijava/io/ByteArrayByteBank.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/ByteBank.java b/src/main/java/org/scijava/io/ByteBank.java
index c79cbd5d4..8d466e8ce 100644
--- a/src/main/java/org/scijava/io/ByteBank.java
+++ b/src/main/java/org/scijava/io/ByteBank.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/DefaultIOService.java b/src/main/java/org/scijava/io/DefaultIOService.java
index b59d2113d..0b67ce690 100644
--- a/src/main/java/org/scijava/io/DefaultIOService.java
+++ b/src/main/java/org/scijava/io/DefaultIOService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -61,6 +61,24 @@ public final class DefaultIOService
@Parameter
private LocationService locationService;
+
+ @Override
+ public IOPlugin getOpener(final String source) throws IOException {
+ try {
+ return getOpener(locationService.resolve(source));
+ } catch (URISyntaxException e) {
+ throw new IOException(e);
+ }
+ }
+
+ @Override
+ public IOPlugin getSaver(D data, String destination) throws IOException {
+ try {
+ return getSaver(data, locationService.resolve(destination));
+ } catch (URISyntaxException e) {
+ throw new IOException(e);
+ }
+ }
@Override
public Object open(final String source) throws IOException {
@@ -112,4 +130,5 @@ public void save(final Object data, final Location destination)
log.error("No Saver IOPlugin found for " + data.toString() + ".");
}
}
+
}
diff --git a/src/main/java/org/scijava/io/DefaultRecentFileService.java b/src/main/java/org/scijava/io/DefaultRecentFileService.java
index 050b22e78..3cef6fb1a 100644
--- a/src/main/java/org/scijava/io/DefaultRecentFileService.java
+++ b/src/main/java/org/scijava/io/DefaultRecentFileService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/IOPlugin.java b/src/main/java/org/scijava/io/IOPlugin.java
index 118b693e2..b8c69cc18 100644
--- a/src/main/java/org/scijava/io/IOPlugin.java
+++ b/src/main/java/org/scijava/io/IOPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -30,9 +30,10 @@
package org.scijava.io;
import java.io.IOException;
+import java.net.URISyntaxException;
-import org.scijava.io.location.FileLocation;
import org.scijava.io.location.Location;
+import org.scijava.io.location.LocationService;
import org.scijava.plugin.HandlerPlugin;
import org.scijava.plugin.Plugin;
@@ -56,24 +57,34 @@ public interface IOPlugin extends HandlerPlugin {
Class getDataType();
/** Checks whether the I/O plugin can open data from the given source. */
- @SuppressWarnings("unused")
default boolean supportsOpen(final String source) {
- return supportsOpen(new FileLocation(source));
+ try {
+ return supportsOpen(context().service(LocationService.class).resolve(source));
+ }
+ catch (final URISyntaxException exc) {
+ return false;
+ }
}
/** Checks whether the I/O plugin can open data from the given location. */
- default boolean supportsOpen(Location source) {
+ @SuppressWarnings("unused")
+ default boolean supportsOpen(final Location source) {
return false;
}
/** Checks whether the I/O plugin can save data to the given destination. */
- @SuppressWarnings("unused")
default boolean supportsSave(final String destination) {
- return supportsSave(new FileLocation(destination));
+ try {
+ return supportsSave(context().service(LocationService.class).resolve(destination));
+ }
+ catch (final URISyntaxException exc) {
+ return false;
+ }
}
/** Checks whether the I/O plugin can save data to the given location. */
- default boolean supportsSave(Location destination) {
+ @SuppressWarnings("unused")
+ default boolean supportsSave(final Location destination) {
return false;
}
@@ -85,7 +96,7 @@ default boolean supportsSave(final Object data, final String destination) {
return supportsSave(destination) && getDataType().isInstance(data);
}
- default boolean supportsSave(Object data, Location destination) {
+ default boolean supportsSave(final Object data, final Location destination) {
return supportsSave(destination) && getDataType().isInstance(data);
}
@@ -96,17 +107,24 @@ default D open(final String source) throws IOException {
}
/** Opens data from the given location. */
- default D open(Location source) throws IOException {
+ @SuppressWarnings("unused")
+ default D open(final Location source) throws IOException {
throw new UnsupportedOperationException();
}
+
/** Saves the given data to the specified destination. */
- @SuppressWarnings("unused")
default void save(final D data, final String destination) throws IOException {
- save(data, new FileLocation(destination));
+ try {
+ save(data, context().service(LocationService.class).resolve(destination));
+ }
+ catch (final URISyntaxException exc) {
+ throw new UnsupportedOperationException(exc);
+ }
}
/** Saves the given data to the specified location. */
- default void save(D data, Location destination) throws IOException {
+ @SuppressWarnings("unused")
+ default void save(final D data, final Location destination) throws IOException {
throw new UnsupportedOperationException();
}
diff --git a/src/main/java/org/scijava/io/IOService.java b/src/main/java/org/scijava/io/IOService.java
index 499e18ea5..672ba9f9b 100644
--- a/src/main/java/org/scijava/io/IOService.java
+++ b/src/main/java/org/scijava/io/IOService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -31,7 +31,6 @@
import java.io.IOException;
-import org.scijava.io.location.FileLocation;
import org.scijava.io.location.Location;
import org.scijava.plugin.HandlerService;
import org.scijava.service.SciJavaService;
@@ -49,9 +48,7 @@ public interface IOService extends HandlerService>,
* Gets the most appropriate {@link IOPlugin} for opening data from the given
* location.
*/
- default IOPlugin getOpener(final String source) {
- return getOpener(new FileLocation(source));
- }
+ IOPlugin getOpener(final String source) throws IOException;
/**
* Gets the most appropriate {@link IOPlugin} for opening data from the given
@@ -68,9 +65,7 @@ default IOPlugin getOpener(Location source) {
* Gets the most appropriate {@link IOPlugin} for saving data to the given
* location.
*/
- default IOPlugin getSaver(final D data, final String destination) {
- return getSaver(data, new FileLocation(destination));
- }
+ IOPlugin getSaver(final D data, final String destination) throws IOException;
/**
* Gets the most appropriate {@link IOPlugin} for saving data to the given
diff --git a/src/main/java/org/scijava/io/RecentFileService.java b/src/main/java/org/scijava/io/RecentFileService.java
index 019d0a6a1..20a6ad9c8 100644
--- a/src/main/java/org/scijava/io/RecentFileService.java
+++ b/src/main/java/org/scijava/io/RecentFileService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/TypedIOService.java b/src/main/java/org/scijava/io/TypedIOService.java
index 0439544e8..e6882fc95 100644
--- a/src/main/java/org/scijava/io/TypedIOService.java
+++ b/src/main/java/org/scijava/io/TypedIOService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -30,9 +30,11 @@
package org.scijava.io;
import java.io.IOException;
+import java.net.URISyntaxException;
import org.scijava.io.location.FileLocation;
import org.scijava.io.location.Location;
+import org.scijava.io.location.LocationService;
import org.scijava.plugin.HandlerService;
import org.scijava.service.SciJavaService;
@@ -51,7 +53,12 @@ public interface TypedIOService extends HandlerService>
* location.
*/
default IOPlugin getOpener(final String source) {
- return getOpener(new FileLocation(source));
+ try {
+ return getOpener(context().service(LocationService.class).resolve(source));
+ }
+ catch (final URISyntaxException exc) {
+ return null;
+ }
}
/**
@@ -70,7 +77,12 @@ default IOPlugin getOpener(Location source) {
* location.
*/
default IOPlugin getSaver(final D data, final String destination) {
- return getSaver(data, new FileLocation(destination));
+ try {
+ return getSaver(data, context().service(LocationService.class).resolve(destination));
+ }
+ catch (final URISyntaxException exc) {
+ return null;
+ }
}
/**
diff --git a/src/main/java/org/scijava/io/console/OpenArgument.java b/src/main/java/org/scijava/io/console/OpenArgument.java
index a198a946e..bfdc3dbdd 100644
--- a/src/main/java/org/scijava/io/console/OpenArgument.java
+++ b/src/main/java/org/scijava/io/console/OpenArgument.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/event/DataOpenedEvent.java b/src/main/java/org/scijava/io/event/DataOpenedEvent.java
index a13d20c18..c177c9195 100644
--- a/src/main/java/org/scijava/io/event/DataOpenedEvent.java
+++ b/src/main/java/org/scijava/io/event/DataOpenedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -49,7 +49,7 @@ public DataOpenedEvent(final Location location, final Object data) {
*/
@Deprecated
public DataOpenedEvent(final String source, final Object data) {
- this(new FileLocation(source), data);
+ super(source, data);
}
/**
@@ -57,12 +57,6 @@ public DataOpenedEvent(final String source, final Object data) {
*/
@Deprecated
public String getSource() {
- try {
- FileLocation fileLocation = (FileLocation) getLocation();
- return fileLocation.getFile().getAbsolutePath();
- } catch(ClassCastException e) {
- return getLocation().getURI().toString();
- }
+ return getDescriptor();
}
-
}
diff --git a/src/main/java/org/scijava/io/event/DataSavedEvent.java b/src/main/java/org/scijava/io/event/DataSavedEvent.java
index 427da0e6a..ec75495c9 100644
--- a/src/main/java/org/scijava/io/event/DataSavedEvent.java
+++ b/src/main/java/org/scijava/io/event/DataSavedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -49,7 +49,7 @@ public DataSavedEvent(final Location destination, final Object data) {
*/
@Deprecated
public DataSavedEvent(final String destination, final Object data) {
- this(new FileLocation(destination), data);
+ super(destination, data);
}
/**
@@ -57,11 +57,6 @@ public DataSavedEvent(final String destination, final Object data) {
*/
@Deprecated
public String getDestination() {
- try {
- FileLocation fileLocation = (FileLocation) getLocation();
- return fileLocation.getFile().getAbsolutePath();
- } catch(ClassCastException e) {
- return getLocation().getURI().toString();
- }
+ return getDescriptor();
}
}
diff --git a/src/main/java/org/scijava/io/event/IOEvent.java b/src/main/java/org/scijava/io/event/IOEvent.java
index f3ff1652a..20a28a191 100644
--- a/src/main/java/org/scijava/io/event/IOEvent.java
+++ b/src/main/java/org/scijava/io/event/IOEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -29,9 +29,12 @@
package org.scijava.io.event;
+import java.net.URISyntaxException;
+
import org.scijava.event.SciJavaEvent;
import org.scijava.io.location.FileLocation;
import org.scijava.io.location.Location;
+import org.scijava.io.location.LocationService;
/**
* An event indicating that I/O (e.g., opening or saving) has occurred.
@@ -43,6 +46,10 @@ public abstract class IOEvent extends SciJavaEvent {
/** The data location (source or destination). */
private final Location location;
+ /** @deprecated use {@link #location} instead */
+ @Deprecated
+ private final String descriptor;
+
/** The data for which I/O took place. */
private final Object data;
@@ -51,17 +58,26 @@ public abstract class IOEvent extends SciJavaEvent {
*/
@Deprecated
public IOEvent(final String descriptor, final Object data) {
- this(new FileLocation(descriptor), data);
+ this.location = null;
+ this.descriptor = descriptor;
+ this.data = data;
}
public IOEvent(final Location location, final Object data) {
this.location = location;
+ this.descriptor = null;
this.data = data;
}
/** Gets the data location (source or destination). */
public Location getLocation() {
- return location;
+ if (location != null) return location;
+ try {
+ return context().service(LocationService.class).resolve(descriptor);
+ }
+ catch (final URISyntaxException exc) {
+ return null;
+ }
}
/** Gets the data for which I/O took place. */
@@ -82,12 +98,11 @@ public String toString() {
*/
@Deprecated
public String getDescriptor() {
- try {
- FileLocation fileLocation = (FileLocation) getLocation();
+ if (descriptor != null) return descriptor;
+ if (location instanceof FileLocation) {
+ final FileLocation fileLocation = (FileLocation) location;
return fileLocation.getFile().getAbsolutePath();
- } catch(ClassCastException e) {
- return getLocation().getURI().toString();
}
+ return location.getURI().toString();
}
-
}
diff --git a/src/main/java/org/scijava/io/handle/AbstractDataHandle.java b/src/main/java/org/scijava/io/handle/AbstractDataHandle.java
index c9007e250..f2446f90a 100644
--- a/src/main/java/org/scijava/io/handle/AbstractDataHandle.java
+++ b/src/main/java/org/scijava/io/handle/AbstractDataHandle.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/handle/AbstractHigherOrderHandle.java b/src/main/java/org/scijava/io/handle/AbstractHigherOrderHandle.java
index fb191561c..7fa3d8df9 100644
--- a/src/main/java/org/scijava/io/handle/AbstractHigherOrderHandle.java
+++ b/src/main/java/org/scijava/io/handle/AbstractHigherOrderHandle.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/handle/AbstractSeekableStreamHandle.java b/src/main/java/org/scijava/io/handle/AbstractSeekableStreamHandle.java
index 838cc9229..5b56c5e93 100644
--- a/src/main/java/org/scijava/io/handle/AbstractSeekableStreamHandle.java
+++ b/src/main/java/org/scijava/io/handle/AbstractSeekableStreamHandle.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/handle/AbstractStreamHandle.java b/src/main/java/org/scijava/io/handle/AbstractStreamHandle.java
index 3c86730a8..75a9f4939 100644
--- a/src/main/java/org/scijava/io/handle/AbstractStreamHandle.java
+++ b/src/main/java/org/scijava/io/handle/AbstractStreamHandle.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/handle/BytesHandle.java b/src/main/java/org/scijava/io/handle/BytesHandle.java
index c967b1380..b09228673 100644
--- a/src/main/java/org/scijava/io/handle/BytesHandle.java
+++ b/src/main/java/org/scijava/io/handle/BytesHandle.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -48,6 +48,14 @@ public class BytesHandle extends AbstractDataHandle {
private long offset = 0;
+ // -- Constructors --
+
+ public BytesHandle() { }
+
+ public BytesHandle(final BytesLocation location) {
+ set(location);
+ }
+
// -- DataHandle methods --
@Override
diff --git a/src/main/java/org/scijava/io/handle/DataHandle.java b/src/main/java/org/scijava/io/handle/DataHandle.java
index 7be53f5bb..18cddadcb 100644
--- a/src/main/java/org/scijava/io/handle/DataHandle.java
+++ b/src/main/java/org/scijava/io/handle/DataHandle.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/handle/DataHandleInputStream.java b/src/main/java/org/scijava/io/handle/DataHandleInputStream.java
index 92e72dcab..10e6b84e9 100644
--- a/src/main/java/org/scijava/io/handle/DataHandleInputStream.java
+++ b/src/main/java/org/scijava/io/handle/DataHandleInputStream.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/handle/DataHandleOutputStream.java b/src/main/java/org/scijava/io/handle/DataHandleOutputStream.java
index 6b30e1c59..3328a4e0a 100644
--- a/src/main/java/org/scijava/io/handle/DataHandleOutputStream.java
+++ b/src/main/java/org/scijava/io/handle/DataHandleOutputStream.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/handle/DataHandleService.java b/src/main/java/org/scijava/io/handle/DataHandleService.java
index dfb5007f4..fae0e7f4a 100644
--- a/src/main/java/org/scijava/io/handle/DataHandleService.java
+++ b/src/main/java/org/scijava/io/handle/DataHandleService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/handle/DataHandles.java b/src/main/java/org/scijava/io/handle/DataHandles.java
index 0ed55abc0..1464f637e 100644
--- a/src/main/java/org/scijava/io/handle/DataHandles.java
+++ b/src/main/java/org/scijava/io/handle/DataHandles.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -30,10 +30,8 @@
package org.scijava.io.handle;
import java.io.DataOutput;
-import java.io.DataOutputStream;
import java.io.IOException;
-import java.lang.reflect.InvocationTargetException;
-import java.lang.reflect.Method;
+import java.io.UTFDataFormatException;
import org.scijava.io.location.Location;
import org.scijava.task.Task;
@@ -46,8 +44,6 @@
*/
public final class DataHandles {
- private static Method utfMethod;
-
private DataHandles() {
// Prevent instantiation of utility class.
}
@@ -74,40 +70,38 @@ private DataHandles() {
public static int writeUTF(final String str, final DataOutput out)
throws IOException
{
- // HACK: Strangely, DataOutputStream.writeUTF(String, DataOutput)
- // has package-private access. We work around it via reflection.
- try {
- return (Integer) utfMethod().invoke(null, str, out);
- }
- catch (final IllegalAccessException | IllegalArgumentException
- | InvocationTargetException exc)
- {
- throw new IllegalStateException(
- "Cannot invoke DataOutputStream.writeUTF(String, DataOutput)", exc);
+ // Encode string as modified UTF-8 per java.io.DataOutput specification.
+ final int strlen = str.length();
+ int utflen = 0;
+ for (int i = 0; i < strlen; i++) {
+ final char c = str.charAt(i);
+ if (c >= '\u0001' && c <= '\u007F') utflen += 1;
+ else if (c <= '\u07FF') utflen += 2;
+ else utflen += 3;
}
- }
-
- // -- Helper methods --
-
- /** Gets the {@link #utfMethod} field, initializing if needed. */
- private static Method utfMethod() {
- if (utfMethod == null) initUTFMethod();
- return utfMethod;
- }
-
- /** Initializes the {@link #utfMethod} field. */
- private static synchronized void initUTFMethod() {
- if (utfMethod != null) return;
- try {
- final Method m = DataOutputStream.class.getDeclaredMethod("writeUTF",
- String.class, DataOutput.class);
- m.setAccessible(true);
- utfMethod = m;
- }
- catch (final NoSuchMethodException | SecurityException exc) {
- throw new IllegalStateException(
- "No usable DataOutputStream.writeUTF(String, DataOutput)", exc);
+ if (utflen > 65535) throw new UTFDataFormatException(
+ "encoded string too long: " + utflen + " bytes");
+ final byte[] bytes = new byte[utflen + 2];
+ bytes[0] = (byte) ((utflen >>> 8) & 0xFF);
+ bytes[1] = (byte) (utflen & 0xFF);
+ int pos = 2;
+ for (int i = 0; i < strlen; i++) {
+ final char c = str.charAt(i);
+ if (c >= '\u0001' && c <= '\u007F') {
+ bytes[pos++] = (byte) c;
+ }
+ else if (c <= '\u07FF') {
+ bytes[pos++] = (byte) (0xC0 | ((c >> 6) & 0x1F));
+ bytes[pos++] = (byte) (0x80 | (c & 0x3F));
+ }
+ else {
+ bytes[pos++] = (byte) (0xE0 | ((c >> 12) & 0x0F));
+ bytes[pos++] = (byte) (0x80 | ((c >> 6) & 0x3F));
+ bytes[pos++] = (byte) (0x80 | (c & 0x3F));
+ }
}
+ out.write(bytes);
+ return utflen + 2;
}
protected static IOException readOnlyException() {
diff --git a/src/main/java/org/scijava/io/handle/DefaultDataHandleService.java b/src/main/java/org/scijava/io/handle/DefaultDataHandleService.java
index 1349653a6..1cdbcdf46 100644
--- a/src/main/java/org/scijava/io/handle/DefaultDataHandleService.java
+++ b/src/main/java/org/scijava/io/handle/DefaultDataHandleService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/handle/DummyHandle.java b/src/main/java/org/scijava/io/handle/DummyHandle.java
index a5b2754b9..74b2d24ab 100644
--- a/src/main/java/org/scijava/io/handle/DummyHandle.java
+++ b/src/main/java/org/scijava/io/handle/DummyHandle.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -48,6 +48,14 @@ public class DummyHandle extends AbstractDataHandle {
private long offset;
private long length;
+ // -- Constructors --
+
+ public DummyHandle() { }
+
+ public DummyHandle(final DummyLocation location) {
+ set(location);
+ }
+
// -- DataHandle methods --
@Override
diff --git a/src/main/java/org/scijava/io/handle/FileHandle.java b/src/main/java/org/scijava/io/handle/FileHandle.java
index ad9822101..3734f7ebb 100644
--- a/src/main/java/org/scijava/io/handle/FileHandle.java
+++ b/src/main/java/org/scijava/io/handle/FileHandle.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -58,6 +58,14 @@ public class FileHandle extends AbstractDataHandle {
/** True iff the {@link #close()} has already been called. */
private boolean closed;
+ // -- Constructors --
+
+ public FileHandle() { }
+
+ public FileHandle(final FileLocation location) {
+ set(location);
+ }
+
// -- FileHandle methods --
/**
diff --git a/src/main/java/org/scijava/io/handle/ReadBufferDataHandle.java b/src/main/java/org/scijava/io/handle/ReadBufferDataHandle.java
index 1d26e20c0..fed7de110 100644
--- a/src/main/java/org/scijava/io/handle/ReadBufferDataHandle.java
+++ b/src/main/java/org/scijava/io/handle/ReadBufferDataHandle.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -44,7 +44,7 @@
* Read-only buffered {@link DataHandle}. It buffers the underlying handle into
* a fixed number of pages, swapping them out when necessary.
*/
-public class ReadBufferDataHandle extends AbstractHigherOrderHandle {
+public class ReadBufferDataHandle extends AbstractHigherOrderHandle {
private static final int DEFAULT_PAGE_SIZE = 10_000;
private static final int DEFAULT_NUM_PAGES = 10;
@@ -55,6 +55,12 @@ public class ReadBufferDataHandle extends AbstractHigherOrderHandle {
private final LRUReplacementStrategy replacementStrategy;
private final Map pageToSlot;
+ /**
+ * Cached length value, for performance. When reading data, length is not
+ * expected to change, but querying it (e.g. via native filesystem access)
+ * can be slow, and we need to query the length frequently.
+ */
+ private long length = -1;
private long offset = 0l;
private byte[] currentPage;
private int currentPageID = -1;
@@ -67,7 +73,7 @@ public class ReadBufferDataHandle extends AbstractHigherOrderHandle {
* @param handle
* the handle to wrap
*/
- public ReadBufferDataHandle(final DataHandle handle) {
+ public ReadBufferDataHandle(final DataHandle handle) {
this(handle, DEFAULT_PAGE_SIZE);
}
@@ -80,7 +86,7 @@ public ReadBufferDataHandle(final DataHandle handle) {
* @param pageSize
* the size of the used pages
*/
- public ReadBufferDataHandle(final DataHandle handle, final int pageSize) {
+ public ReadBufferDataHandle(final DataHandle handle, final int pageSize) {
this(handle, pageSize, DEFAULT_NUM_PAGES);
}
@@ -94,7 +100,7 @@ public ReadBufferDataHandle(final DataHandle handle, final int pageSiz
* @param numPages
* the number of pages to use
*/
- public ReadBufferDataHandle(final DataHandle handle, final int pageSize, final int numPages) {
+ public ReadBufferDataHandle(final DataHandle handle, final int pageSize, final int numPages) {
super(handle);
this.pageSize = pageSize;
@@ -190,6 +196,12 @@ public void seek(final long pos) throws IOException {
this.offset = pos;
}
+ @Override
+ public long length() throws IOException {
+ if (length < 0) length = super.length();
+ return length;
+ }
+
@Override
public int read(final byte[] b, final int targetOffset, final int len)
throws IOException
diff --git a/src/main/java/org/scijava/io/handle/ResettableStreamHandle.java b/src/main/java/org/scijava/io/handle/ResettableStreamHandle.java
index 17859653a..b4a7310f8 100644
--- a/src/main/java/org/scijava/io/handle/ResettableStreamHandle.java
+++ b/src/main/java/org/scijava/io/handle/ResettableStreamHandle.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/handle/SeekableStreamHandle.java b/src/main/java/org/scijava/io/handle/SeekableStreamHandle.java
index 1740b7b70..6b4746f56 100644
--- a/src/main/java/org/scijava/io/handle/SeekableStreamHandle.java
+++ b/src/main/java/org/scijava/io/handle/SeekableStreamHandle.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/handle/StreamHandle.java b/src/main/java/org/scijava/io/handle/StreamHandle.java
index 5a4169535..30a3e88ba 100644
--- a/src/main/java/org/scijava/io/handle/StreamHandle.java
+++ b/src/main/java/org/scijava/io/handle/StreamHandle.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/handle/WriteBufferDataHandle.java b/src/main/java/org/scijava/io/handle/WriteBufferDataHandle.java
index db400b26a..f1549aa30 100644
--- a/src/main/java/org/scijava/io/handle/WriteBufferDataHandle.java
+++ b/src/main/java/org/scijava/io/handle/WriteBufferDataHandle.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/location/AbstractLocation.java b/src/main/java/org/scijava/io/location/AbstractLocation.java
index a629c9b48..007a1a8a9 100644
--- a/src/main/java/org/scijava/io/location/AbstractLocation.java
+++ b/src/main/java/org/scijava/io/location/AbstractLocation.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/location/AbstractLocationResolver.java b/src/main/java/org/scijava/io/location/AbstractLocationResolver.java
index 93616403e..b40f6c0d9 100644
--- a/src/main/java/org/scijava/io/location/AbstractLocationResolver.java
+++ b/src/main/java/org/scijava/io/location/AbstractLocationResolver.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/location/AbstractRemoteLocation.java b/src/main/java/org/scijava/io/location/AbstractRemoteLocation.java
index c36f21bbf..61b3f9735 100644
--- a/src/main/java/org/scijava/io/location/AbstractRemoteLocation.java
+++ b/src/main/java/org/scijava/io/location/AbstractRemoteLocation.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/location/BrowsableLocation.java b/src/main/java/org/scijava/io/location/BrowsableLocation.java
index 312df412c..f6efc3b99 100644
--- a/src/main/java/org/scijava/io/location/BrowsableLocation.java
+++ b/src/main/java/org/scijava/io/location/BrowsableLocation.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/location/BytesLocation.java b/src/main/java/org/scijava/io/location/BytesLocation.java
index 0d6210d69..0b7f604ed 100644
--- a/src/main/java/org/scijava/io/location/BytesLocation.java
+++ b/src/main/java/org/scijava/io/location/BytesLocation.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/location/DefaultLocationService.java b/src/main/java/org/scijava/io/location/DefaultLocationService.java
index 92ba74047..028dd807e 100644
--- a/src/main/java/org/scijava/io/location/DefaultLocationService.java
+++ b/src/main/java/org/scijava/io/location/DefaultLocationService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/location/DummyLocation.java b/src/main/java/org/scijava/io/location/DummyLocation.java
index 676bd87df..0a9dd546f 100644
--- a/src/main/java/org/scijava/io/location/DummyLocation.java
+++ b/src/main/java/org/scijava/io/location/DummyLocation.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/location/FileLocation.java b/src/main/java/org/scijava/io/location/FileLocation.java
index 03480c0ae..4cf688d3b 100644
--- a/src/main/java/org/scijava/io/location/FileLocation.java
+++ b/src/main/java/org/scijava/io/location/FileLocation.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/location/FileLocationResolver.java b/src/main/java/org/scijava/io/location/FileLocationResolver.java
index b8d642d3e..5e6b19df0 100644
--- a/src/main/java/org/scijava/io/location/FileLocationResolver.java
+++ b/src/main/java/org/scijava/io/location/FileLocationResolver.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/location/Location.java b/src/main/java/org/scijava/io/location/Location.java
index 470c9cb22..2c579ad7e 100644
--- a/src/main/java/org/scijava/io/location/Location.java
+++ b/src/main/java/org/scijava/io/location/Location.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/location/LocationResolver.java b/src/main/java/org/scijava/io/location/LocationResolver.java
index 9dd2c650c..e4c60eada 100644
--- a/src/main/java/org/scijava/io/location/LocationResolver.java
+++ b/src/main/java/org/scijava/io/location/LocationResolver.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/location/LocationService.java b/src/main/java/org/scijava/io/location/LocationService.java
index 0d6104815..078eca44c 100644
--- a/src/main/java/org/scijava/io/location/LocationService.java
+++ b/src/main/java/org/scijava/io/location/LocationService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -56,14 +56,15 @@ public interface LocationService extends HandlerService,
*/
default Location resolve(final String uriString) throws URISyntaxException {
try {
- return resolve(new URI(uriString));
+ Location loc = resolve(new URI(uriString));
+ if (loc != null) return loc;
}
catch (final URISyntaxException exc) {
// In general, filenames are not valid URI strings.
// Particularly on Windows, there are backslashes, which are invalid in URIs.
// So we explicitly turn this string into a file if an error happens above.
- return resolve(new File(uriString).toURI());
}
+ return resolve(new File(uriString).toURI());
}
/**
diff --git a/src/main/java/org/scijava/io/location/RemoteLocation.java b/src/main/java/org/scijava/io/location/RemoteLocation.java
index f9bc1b608..20fd65fef 100644
--- a/src/main/java/org/scijava/io/location/RemoteLocation.java
+++ b/src/main/java/org/scijava/io/location/RemoteLocation.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/location/URILocation.java b/src/main/java/org/scijava/io/location/URILocation.java
index 3311412e0..52621ea91 100644
--- a/src/main/java/org/scijava/io/location/URILocation.java
+++ b/src/main/java/org/scijava/io/location/URILocation.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -112,7 +112,7 @@ private Map decodeQuery(final String query) {
* @see URLDecoder
*/
private String decode(final String s) {
- // http://stackoverflow.com/a/6926987
+ // https://stackoverflow.com/a/6926987
try {
return URLDecoder.decode(s.replace("+", "%2B"), "UTF-8");
}
diff --git a/src/main/java/org/scijava/io/location/URLLocation.java b/src/main/java/org/scijava/io/location/URLLocation.java
index d7e4ed49e..396dedeae 100644
--- a/src/main/java/org/scijava/io/location/URLLocation.java
+++ b/src/main/java/org/scijava/io/location/URLLocation.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/nio/ByteBufferByteBank.java b/src/main/java/org/scijava/io/nio/ByteBufferByteBank.java
index 8fb6b0c52..6f9ec504d 100644
--- a/src/main/java/org/scijava/io/nio/ByteBufferByteBank.java
+++ b/src/main/java/org/scijava/io/nio/ByteBufferByteBank.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/nio/DefaultNIOService.java b/src/main/java/org/scijava/io/nio/DefaultNIOService.java
index 8bff57a73..2550caab8 100644
--- a/src/main/java/org/scijava/io/nio/DefaultNIOService.java
+++ b/src/main/java/org/scijava/io/nio/DefaultNIOService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/io/nio/NIOService.java b/src/main/java/org/scijava/io/nio/NIOService.java
index cbc8d681d..5e90ced72 100644
--- a/src/main/java/org/scijava/io/nio/NIOService.java
+++ b/src/main/java/org/scijava/io/nio/NIOService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -60,8 +60,8 @@ public interface NIOService extends SciJavaService {
* buffer.
* @param newSize The buffer size.
* @return A newly allocated or mapped NIO byte buffer.
- * @see "http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=5092131"
- * @see "http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6417205"
+ * @see "https://bugs.java.com/bugdatabase/view_bug.do?bug_id=5092131"
+ * @see "https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6417205"
* @throws IOException If there is an issue mapping, aligning or allocating
* the buffer.
*/
diff --git a/src/main/java/org/scijava/log/AbstractLogService.java b/src/main/java/org/scijava/log/AbstractLogService.java
index 5ae980645..099750f95 100644
--- a/src/main/java/org/scijava/log/AbstractLogService.java
+++ b/src/main/java/org/scijava/log/AbstractLogService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/log/CallingClassUtils.java b/src/main/java/org/scijava/log/CallingClassUtils.java
index fc1250e78..3a615a5b2 100644
--- a/src/main/java/org/scijava/log/CallingClassUtils.java
+++ b/src/main/java/org/scijava/log/CallingClassUtils.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/log/DefaultLogger.java b/src/main/java/org/scijava/log/DefaultLogger.java
index f11ec5ae0..a5522aa50 100644
--- a/src/main/java/org/scijava/log/DefaultLogger.java
+++ b/src/main/java/org/scijava/log/DefaultLogger.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/log/DefaultUncaughtExceptionHandler.java b/src/main/java/org/scijava/log/DefaultUncaughtExceptionHandler.java
index d8d45c4d5..d562921e5 100644
--- a/src/main/java/org/scijava/log/DefaultUncaughtExceptionHandler.java
+++ b/src/main/java/org/scijava/log/DefaultUncaughtExceptionHandler.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/log/IgnoreAsCallingClass.java b/src/main/java/org/scijava/log/IgnoreAsCallingClass.java
index 775c7b4ff..5aa4a690a 100644
--- a/src/main/java/org/scijava/log/IgnoreAsCallingClass.java
+++ b/src/main/java/org/scijava/log/IgnoreAsCallingClass.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/log/LogLevel.java b/src/main/java/org/scijava/log/LogLevel.java
index 276970ae2..aabab92aa 100644
--- a/src/main/java/org/scijava/log/LogLevel.java
+++ b/src/main/java/org/scijava/log/LogLevel.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/log/LogListener.java b/src/main/java/org/scijava/log/LogListener.java
index 8c4047849..19c03c71f 100644
--- a/src/main/java/org/scijava/log/LogListener.java
+++ b/src/main/java/org/scijava/log/LogListener.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/log/LogMessage.java b/src/main/java/org/scijava/log/LogMessage.java
index 235de87f1..dce591878 100644
--- a/src/main/java/org/scijava/log/LogMessage.java
+++ b/src/main/java/org/scijava/log/LogMessage.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/log/LogService.java b/src/main/java/org/scijava/log/LogService.java
index 4675e0eab..ad9cdb40b 100644
--- a/src/main/java/org/scijava/log/LogService.java
+++ b/src/main/java/org/scijava/log/LogService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/log/LogSource.java b/src/main/java/org/scijava/log/LogSource.java
index af8e6802e..5f03b1870 100644
--- a/src/main/java/org/scijava/log/LogSource.java
+++ b/src/main/java/org/scijava/log/LogSource.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/log/Logged.java b/src/main/java/org/scijava/log/Logged.java
index 8e15caf9e..bee37e0fa 100644
--- a/src/main/java/org/scijava/log/Logged.java
+++ b/src/main/java/org/scijava/log/Logged.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/log/Logger.java b/src/main/java/org/scijava/log/Logger.java
index eccb06796..c2657b0b0 100644
--- a/src/main/java/org/scijava/log/Logger.java
+++ b/src/main/java/org/scijava/log/Logger.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/log/StderrLogService.java b/src/main/java/org/scijava/log/StderrLogService.java
index f387991d2..8c67b082b 100644
--- a/src/main/java/org/scijava/log/StderrLogService.java
+++ b/src/main/java/org/scijava/log/StderrLogService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/main/DefaultMainService.java b/src/main/java/org/scijava/main/DefaultMainService.java
index 81677d5c2..699a78132 100644
--- a/src/main/java/org/scijava/main/DefaultMainService.java
+++ b/src/main/java/org/scijava/main/DefaultMainService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/main/MainService.java b/src/main/java/org/scijava/main/MainService.java
index f1e76b85f..36b92b89b 100644
--- a/src/main/java/org/scijava/main/MainService.java
+++ b/src/main/java/org/scijava/main/MainService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/main/console/MainArgument.java b/src/main/java/org/scijava/main/console/MainArgument.java
index 71a116fb6..0e0ebe29d 100644
--- a/src/main/java/org/scijava/main/console/MainArgument.java
+++ b/src/main/java/org/scijava/main/console/MainArgument.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/main/run/MainCodeRunner.java b/src/main/java/org/scijava/main/run/MainCodeRunner.java
index f1da7f002..a18ae6b3b 100644
--- a/src/main/java/org/scijava/main/run/MainCodeRunner.java
+++ b/src/main/java/org/scijava/main/run/MainCodeRunner.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/menu/AbstractMenuCreator.java b/src/main/java/org/scijava/menu/AbstractMenuCreator.java
index 8d076304c..726639ae8 100644
--- a/src/main/java/org/scijava/menu/AbstractMenuCreator.java
+++ b/src/main/java/org/scijava/menu/AbstractMenuCreator.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/menu/DefaultMenuService.java b/src/main/java/org/scijava/menu/DefaultMenuService.java
index 287e28e5b..74ed27285 100644
--- a/src/main/java/org/scijava/menu/DefaultMenuService.java
+++ b/src/main/java/org/scijava/menu/DefaultMenuService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/menu/MenuConstants.java b/src/main/java/org/scijava/menu/MenuConstants.java
index 24e27506b..8c38942c9 100644
--- a/src/main/java/org/scijava/menu/MenuConstants.java
+++ b/src/main/java/org/scijava/menu/MenuConstants.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/menu/MenuCreator.java b/src/main/java/org/scijava/menu/MenuCreator.java
index d5ddc13d9..386771672 100644
--- a/src/main/java/org/scijava/menu/MenuCreator.java
+++ b/src/main/java/org/scijava/menu/MenuCreator.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/menu/MenuService.java b/src/main/java/org/scijava/menu/MenuService.java
index 1a9a98a13..ce9a5d36c 100644
--- a/src/main/java/org/scijava/menu/MenuService.java
+++ b/src/main/java/org/scijava/menu/MenuService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/menu/ShadowMenu.java b/src/main/java/org/scijava/menu/ShadowMenu.java
index a364d827e..c5eaea4cd 100644
--- a/src/main/java/org/scijava/menu/ShadowMenu.java
+++ b/src/main/java/org/scijava/menu/ShadowMenu.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -230,17 +230,24 @@ public URL getIconURL() {
if (isLeaf()) iconPath = DEFAULT_ICON_PATH;
else return null;
}
- final String className = moduleInfo.getDelegateClassName();
try {
- final Class c = Types.load(className, false);
+ final Class c = moduleInfo.loadDelegateClass();
final URL iconURL = c.getResource(iconPath);
if (iconURL == null) {
if (log != null) log.error("Could not load icon: " + iconPath);
}
return iconURL;
}
+ catch (final ClassNotFoundException exc) {
+ final String message = "Failed to load class: " +
+ moduleInfo.getDelegateClassName();
+ if (log.isDebug()) log.debug(message, exc);
+ else log.error(message);
+ return null;
+ }
catch (final IllegalArgumentException exc) {
- final String message = "Could not load icon for class: " + className;
+ final String message = "Could not load icon for class: " +
+ moduleInfo.getDelegateClassName();
if (log.isDebug()) log.debug(message, exc);
else log.error(message);
return null;
diff --git a/src/main/java/org/scijava/menu/ShadowMenuIterator.java b/src/main/java/org/scijava/menu/ShadowMenuIterator.java
index 5c1471f7d..ea69e7a2f 100644
--- a/src/main/java/org/scijava/menu/ShadowMenuIterator.java
+++ b/src/main/java/org/scijava/menu/ShadowMenuIterator.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/menu/event/MenuEvent.java b/src/main/java/org/scijava/menu/event/MenuEvent.java
index 56a29995a..ae0deaa13 100644
--- a/src/main/java/org/scijava/menu/event/MenuEvent.java
+++ b/src/main/java/org/scijava/menu/event/MenuEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/menu/event/MenusAddedEvent.java b/src/main/java/org/scijava/menu/event/MenusAddedEvent.java
index 77b4626d4..a3fd70e2f 100644
--- a/src/main/java/org/scijava/menu/event/MenusAddedEvent.java
+++ b/src/main/java/org/scijava/menu/event/MenusAddedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/menu/event/MenusRemovedEvent.java b/src/main/java/org/scijava/menu/event/MenusRemovedEvent.java
index 717f4be7c..24e3a8f93 100644
--- a/src/main/java/org/scijava/menu/event/MenusRemovedEvent.java
+++ b/src/main/java/org/scijava/menu/event/MenusRemovedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/menu/event/MenusUpdatedEvent.java b/src/main/java/org/scijava/menu/event/MenusUpdatedEvent.java
index 781a6c998..951daace8 100644
--- a/src/main/java/org/scijava/menu/event/MenusUpdatedEvent.java
+++ b/src/main/java/org/scijava/menu/event/MenusUpdatedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/AbstractModule.java b/src/main/java/org/scijava/module/AbstractModule.java
index e30a52a1c..4ca6a4528 100644
--- a/src/main/java/org/scijava/module/AbstractModule.java
+++ b/src/main/java/org/scijava/module/AbstractModule.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -160,8 +160,13 @@ public void resolveInput(final String name) {
item.validate(this);
}
catch (final MethodCallException exc) {
- // NB: Hacky, but avoids changing the API signature.
- throw new RuntimeException(exc);
+ // NB: resolveInput cannot declare checked exceptions, so we wrap.
+ // Prefer the cause's message (the user-facing validation error) when
+ // available; otherwise fall back to the MethodCallException's message.
+ final Throwable cause = exc.getCause();
+ final String message = (cause != null && cause.getMessage() != null &&
+ !cause.getMessage().isEmpty()) ? cause.getMessage() : exc.getMessage();
+ throw new RuntimeException(message, exc);
}
}
resolvedInputs.add(name);
diff --git a/src/main/java/org/scijava/module/AbstractModuleInfo.java b/src/main/java/org/scijava/module/AbstractModuleInfo.java
index 196b11ab5..704ac4cd3 100644
--- a/src/main/java/org/scijava/module/AbstractModuleInfo.java
+++ b/src/main/java/org/scijava/module/AbstractModuleInfo.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/AbstractModuleItem.java b/src/main/java/org/scijava/module/AbstractModuleItem.java
index b96941e8d..e2648cd2f 100644
--- a/src/main/java/org/scijava/module/AbstractModuleItem.java
+++ b/src/main/java/org/scijava/module/AbstractModuleItem.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -210,7 +210,12 @@ public void validate(final Module module) throws MethodCallException {
if (validaterRef == null) {
validaterRef = new MethodRef(delegateObject.getClass(), getValidater());
}
- validaterRef.execute(module.getDelegateObject());
+ final Object result = validaterRef.executeWithResult(module.getDelegateObject());
+ // If the validater returns a non-empty String, treat it as an error message.
+ if (result instanceof String) {
+ final String message = (String) result;
+ if (!message.isEmpty()) throw new MethodCallException(message);
+ }
}
@Override
diff --git a/src/main/java/org/scijava/module/DefaultModuleService.java b/src/main/java/org/scijava/module/DefaultModuleService.java
index 228cee0b1..c6dee7f42 100644
--- a/src/main/java/org/scijava/module/DefaultModuleService.java
+++ b/src/main/java/org/scijava/module/DefaultModuleService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -74,7 +74,7 @@ public class DefaultModuleService extends AbstractService implements
ModuleService
{
- @Parameter
+ @Parameter(required = false)
private LogService log;
@Parameter
@@ -170,7 +170,7 @@ public Module createModule(final ModuleInfo info) {
return module;
}
catch (final ModuleException exc) {
- log.error("Cannot create module: " + info.getDelegateClassName(), exc);
+ if (log != null) log.error("Cannot create module: " + info.getDelegateClassName(), exc);
}
return null;
}
@@ -251,10 +251,10 @@ public M waitFor(final Future future) {
return future.get();
}
catch (final InterruptedException e) {
- log.error("Module execution interrupted", e);
+ if (log != null) log.error("Module execution interrupted", e);
}
catch (final ExecutionException e) {
- log.error("Error during module execution", e);
+ if (log != null) log.error("Error during module execution", e);
}
return null;
}
@@ -392,8 +392,10 @@ private Module getRegisteredModuleInstance(final ModuleInfo info) {
}
if (objects.size() > 1) {
// there are multiple instances; it's not clear which one to use
- log.warn("Ignoring multiple candidate module instances for class: " +
- type.getName());
+ if (log != null) {
+ log.warn("Ignoring multiple candidate module instances for class: " +
+ type.getName());
+ }
return null;
}
// found exactly one instance; return it!
@@ -416,7 +418,7 @@ private Map createMap(final Object[] values) {
final Map valueMap = (Map) values[0];
for (final Object key : valueMap.keySet()) {
if (!(key instanceof String)) {
- log.error("Invalid input name: " + key);
+ if (log != null) log.error("Invalid input name: " + key);
continue;
}
final String name = (String) key;
@@ -427,7 +429,7 @@ private Map createMap(final Object[] values) {
}
if (values.length % 2 != 0) {
- log.error("Ignoring extraneous argument: " + values[values.length - 1]);
+ if (log != null) log.error("Ignoring extraneous argument: " + values[values.length - 1]);
}
// loop over list of key/value pairs
@@ -436,7 +438,7 @@ private Map createMap(final Object[] values) {
final Object key = values[2 * i];
final Object value = values[2 * i + 1];
if (!(key instanceof String)) {
- log.error("Invalid input name: " + key);
+ if (log != null) log.error("Invalid input name: " + key);
continue;
}
final String name = (String) key;
@@ -459,7 +461,7 @@ private void assignInputs(final Module module,
if (input == null) {
// inputs whose name starts with a dot are implicitly known by convention
if (!name.startsWith(".")) {
- log.warn("Unmatched input: " + name);
+ if (log != null) log.warn("Unmatched input: " + name);
}
converted = value;
}
@@ -467,8 +469,10 @@ private void assignInputs(final Module module,
final Class type = input.getType();
converted = convertService.convert(value, type);
if (value != null && converted == null) {
- log.error("For input " + name + ": incompatible object " +
- value.getClass().getName() + " for type " + type.getName());
+ if (log != null) {
+ log.error("For input " + name + ": incompatible object " +
+ value.getClass().getName() + " for type " + type.getName());
+ }
continue;
}
}
diff --git a/src/main/java/org/scijava/module/DefaultMutableModule.java b/src/main/java/org/scijava/module/DefaultMutableModule.java
index 29c28bdfb..0e646a212 100644
--- a/src/main/java/org/scijava/module/DefaultMutableModule.java
+++ b/src/main/java/org/scijava/module/DefaultMutableModule.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/DefaultMutableModuleInfo.java b/src/main/java/org/scijava/module/DefaultMutableModuleInfo.java
index a7b2c8de2..372776ab9 100644
--- a/src/main/java/org/scijava/module/DefaultMutableModuleInfo.java
+++ b/src/main/java/org/scijava/module/DefaultMutableModuleInfo.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/DefaultMutableModuleItem.java b/src/main/java/org/scijava/module/DefaultMutableModuleItem.java
index fc74b85d0..c16ea80ec 100644
--- a/src/main/java/org/scijava/module/DefaultMutableModuleItem.java
+++ b/src/main/java/org/scijava/module/DefaultMutableModuleItem.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/MethodCallException.java b/src/main/java/org/scijava/module/MethodCallException.java
index 823220f4c..fc37d1313 100644
--- a/src/main/java/org/scijava/module/MethodCallException.java
+++ b/src/main/java/org/scijava/module/MethodCallException.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/MethodRef.java b/src/main/java/org/scijava/module/MethodRef.java
index 2761aaa25..f77883204 100644
--- a/src/main/java/org/scijava/module/MethodRef.java
+++ b/src/main/java/org/scijava/module/MethodRef.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -62,9 +62,15 @@ public MethodRef(final Class clazz, final String methodName,
public void execute(final Object obj, final Object... args)
throws MethodCallException
{
- if (method == null) return;
+ executeWithResult(obj, args);
+ }
+
+ public Object executeWithResult(final Object obj, final Object... args)
+ throws MethodCallException
+ {
+ if (method == null) return null;
try {
- method.invoke(obj, args);
+ return method.invoke(obj, args);
}
catch (final Exception exc) {
// NB: Several types of exceptions; simpler to handle them all the same.
diff --git a/src/main/java/org/scijava/module/Module.java b/src/main/java/org/scijava/module/Module.java
index 35ae5decd..21e6730bf 100644
--- a/src/main/java/org/scijava/module/Module.java
+++ b/src/main/java/org/scijava/module/Module.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/ModuleCanceledException.java b/src/main/java/org/scijava/module/ModuleCanceledException.java
index df33ba8c9..f500a4167 100644
--- a/src/main/java/org/scijava/module/ModuleCanceledException.java
+++ b/src/main/java/org/scijava/module/ModuleCanceledException.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/ModuleException.java b/src/main/java/org/scijava/module/ModuleException.java
index 59d490f17..9f9f3cb7c 100644
--- a/src/main/java/org/scijava/module/ModuleException.java
+++ b/src/main/java/org/scijava/module/ModuleException.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/ModuleIndex.java b/src/main/java/org/scijava/module/ModuleIndex.java
index f40875599..998568f10 100644
--- a/src/main/java/org/scijava/module/ModuleIndex.java
+++ b/src/main/java/org/scijava/module/ModuleIndex.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/ModuleInfo.java b/src/main/java/org/scijava/module/ModuleInfo.java
index bcf7107f5..c9b687177 100644
--- a/src/main/java/org/scijava/module/ModuleInfo.java
+++ b/src/main/java/org/scijava/module/ModuleInfo.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/ModuleItem.java b/src/main/java/org/scijava/module/ModuleItem.java
index b226bcde0..95ea748b4 100644
--- a/src/main/java/org/scijava/module/ModuleItem.java
+++ b/src/main/java/org/scijava/module/ModuleItem.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -126,11 +126,52 @@ public interface ModuleItem extends BasicDetails {
/**
* Invokes this item's validation function, if any, on the given module.
- *
+ *
+ * The validation function may signal failure either by throwing an exception
+ * or by returning a non-empty {@link String} error message.
+ *
+ *
+ * @throws MethodCallException if validation fails or the method cannot be
+ * invoked. When the validater returns a non-empty String, a
+ * {@link MethodCallException} is thrown with that string as its
+ * message.
* @see #getValidater()
+ * @see #validateMessage(Module)
*/
void validate(Module module) throws MethodCallException;
+ /**
+ * Validates this item's value in the given module, returning any error
+ * message rather than throwing.
+ *
+ * The validation function may signal failure either by throwing an exception
+ * or by returning a non-empty {@link String} error message. This method
+ * catches both cases and returns the error message as a string, or
+ * {@code null} if the value is valid.
+ *
+ *
+ * @return an error message if the value is invalid, or {@code null} if valid.
+ * @see #getValidater()
+ * @see #validate(Module)
+ */
+ default String validateMessage(final Module module) {
+ try {
+ validate(module);
+ return null;
+ }
+ catch (final MethodCallException exc) {
+ // Unwrap to find the most informative message.
+ final Throwable cause = exc.getCause();
+ if (cause != null && cause.getMessage() != null &&
+ !cause.getMessage().isEmpty())
+ {
+ return cause.getMessage();
+ }
+ final String msg = exc.getMessage();
+ return msg != null && !msg.isEmpty() ? msg : exc.toString();
+ }
+ }
+
/**
* Gets the function that is called whenever this item changes.
*
diff --git a/src/main/java/org/scijava/module/ModuleRunner.java b/src/main/java/org/scijava/module/ModuleRunner.java
index 0a4cff44e..ece995d8a 100644
--- a/src/main/java/org/scijava/module/ModuleRunner.java
+++ b/src/main/java/org/scijava/module/ModuleRunner.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -39,6 +39,7 @@
import org.scijava.event.EventService;
import org.scijava.log.LogService;
import org.scijava.module.event.ModuleCanceledEvent;
+import org.scijava.module.event.ModuleErroredEvent;
import org.scijava.module.event.ModuleExecutedEvent;
import org.scijava.module.event.ModuleExecutingEvent;
import org.scijava.module.event.ModuleFinishedEvent;
@@ -144,36 +145,42 @@ public void run() {
final String title = module.getInfo().getTitle();
- // announce start of execution process
- if (ss != null) ss.showStatus("Running command: " + title);
- if (es != null) es.publish(new ModuleStartedEvent(module));
-
- // execute preprocessors
- final ModulePreprocessor canceler = preProcess();
- if (canceler != null) {
- // module execution was canceled by preprocessor
- final String reason = canceler.getCancelReason();
- cancel(reason);
- cleanupAndBroadcastCancelation(title, reason);
- return;
+ try {
+ // announce start of execution process
+ if (ss != null) ss.showStatus("Running command: " + title);
+ if (es != null) es.publish(new ModuleStartedEvent(module));
+
+ // execute preprocessors
+ final ModulePreprocessor canceler = preProcess();
+ if (canceler != null) {
+ // module execution was canceled by preprocessor
+ final String reason = canceler.getCancelReason();
+ cancel(reason);
+ cleanupAndBroadcastCancelation(title, reason);
+ return;
+ }
+
+ // execute module
+ if (es != null) es.publish(new ModuleExecutingEvent(module));
+ module.run();
+ if (isCanceled()) {
+ // module execution was canceled by the module itself
+ cleanupAndBroadcastCancelation(title, getCancelReason());
+ return;
+ }
+ if (es != null) es.publish(new ModuleExecutedEvent(module));
+
+ // execute postprocessors
+ postProcess();
+
+ // announce completion of execution process
+ if (es != null) es.publish(new ModuleFinishedEvent(module));
+ if (ss != null) ss.showStatus("Command finished: " + title);
}
-
- // execute module
- if (es != null) es.publish(new ModuleExecutingEvent(module));
- module.run();
- if (isCanceled()) {
- // module execution was canceled by the module itself
- cleanupAndBroadcastCancelation(title, getCancelReason());
- return;
+ catch (final Throwable t) {
+ cleanupAndBroadcastException(title, t);
+ throw t;
}
- if (es != null) es.publish(new ModuleExecutedEvent(module));
-
- // execute postprocessors
- postProcess();
-
- // announce completion of execution process
- if (es != null) es.publish(new ModuleFinishedEvent(module));
- if (ss != null) ss.showStatus("Command finished: " + title);
}
// -- Helper methods --
@@ -190,6 +197,17 @@ private void cleanupAndBroadcastCancelation(final String title,
}
}
+ private void cleanupAndBroadcastException(final String title,
+ final Throwable t)
+ {
+ final ModuleErroredEvent evt = new ModuleErroredEvent(module, t);
+ if (es != null) es.publish(evt);
+ if (log != null && !evt.isConsumed()) {
+ // Nothing else handled the error, so log it.
+ log.error("Command errored: " + title, t);
+ }
+ }
+
private boolean isCanceled() {
return module instanceof Cancelable && ((Cancelable) module).isCanceled();
}
diff --git a/src/main/java/org/scijava/module/ModuleService.java b/src/main/java/org/scijava/module/ModuleService.java
index ffcbb4d0d..3f97a56e4 100644
--- a/src/main/java/org/scijava/module/ModuleService.java
+++ b/src/main/java/org/scijava/module/ModuleService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/MutableModule.java b/src/main/java/org/scijava/module/MutableModule.java
index 294a7c66a..3a907c854 100644
--- a/src/main/java/org/scijava/module/MutableModule.java
+++ b/src/main/java/org/scijava/module/MutableModule.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/MutableModuleInfo.java b/src/main/java/org/scijava/module/MutableModuleInfo.java
index 976603838..31aeb7280 100644
--- a/src/main/java/org/scijava/module/MutableModuleInfo.java
+++ b/src/main/java/org/scijava/module/MutableModuleInfo.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/MutableModuleItem.java b/src/main/java/org/scijava/module/MutableModuleItem.java
index fc3dfa6a0..413950216 100644
--- a/src/main/java/org/scijava/module/MutableModuleItem.java
+++ b/src/main/java/org/scijava/module/MutableModuleItem.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/event/ModuleCanceledEvent.java b/src/main/java/org/scijava/module/event/ModuleCanceledEvent.java
index eef9c42d1..baa6ce737 100644
--- a/src/main/java/org/scijava/module/event/ModuleCanceledEvent.java
+++ b/src/main/java/org/scijava/module/event/ModuleCanceledEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/event/ModuleErroredEvent.java b/src/main/java/org/scijava/module/event/ModuleErroredEvent.java
new file mode 100644
index 000000000..381cc0a4e
--- /dev/null
+++ b/src/main/java/org/scijava/module/event/ModuleErroredEvent.java
@@ -0,0 +1,52 @@
+/*
+ * #%L
+ * SciJava Common shared library for SciJava software.
+ * %%
+ * Copyright (C) 2009 - 2026 SciJava developers.
+ * %%
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ * #L%
+ */
+
+package org.scijava.module.event;
+
+import org.scijava.module.Module;
+
+/**
+ * An event indicating a module execution has thrown an exception.
+ *
+ * @author Gabriel Selzer
+ */
+public class ModuleErroredEvent extends ModuleExecutionEvent {
+
+ private final Throwable exc;
+
+ public ModuleErroredEvent(final Module module, final Throwable exc) {
+ super(module);
+ this.exc = exc;
+ }
+
+ public Throwable getException() {
+ return exc;
+ }
+
+}
diff --git a/src/main/java/org/scijava/module/event/ModuleEvent.java b/src/main/java/org/scijava/module/event/ModuleEvent.java
index f059dd3a9..9d402399a 100644
--- a/src/main/java/org/scijava/module/event/ModuleEvent.java
+++ b/src/main/java/org/scijava/module/event/ModuleEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/event/ModuleExecutedEvent.java b/src/main/java/org/scijava/module/event/ModuleExecutedEvent.java
index f8b17ed12..c8ec50ca5 100644
--- a/src/main/java/org/scijava/module/event/ModuleExecutedEvent.java
+++ b/src/main/java/org/scijava/module/event/ModuleExecutedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/event/ModuleExecutingEvent.java b/src/main/java/org/scijava/module/event/ModuleExecutingEvent.java
index e3ba97c10..5110625e8 100644
--- a/src/main/java/org/scijava/module/event/ModuleExecutingEvent.java
+++ b/src/main/java/org/scijava/module/event/ModuleExecutingEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/event/ModuleExecutionEvent.java b/src/main/java/org/scijava/module/event/ModuleExecutionEvent.java
index 3f6aa0c97..73bfa9d14 100644
--- a/src/main/java/org/scijava/module/event/ModuleExecutionEvent.java
+++ b/src/main/java/org/scijava/module/event/ModuleExecutionEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/event/ModuleFinishedEvent.java b/src/main/java/org/scijava/module/event/ModuleFinishedEvent.java
index d72d0cd07..4c0f71dbf 100644
--- a/src/main/java/org/scijava/module/event/ModuleFinishedEvent.java
+++ b/src/main/java/org/scijava/module/event/ModuleFinishedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/event/ModulePostprocessEvent.java b/src/main/java/org/scijava/module/event/ModulePostprocessEvent.java
index 6402c8e1a..e59f94ff2 100644
--- a/src/main/java/org/scijava/module/event/ModulePostprocessEvent.java
+++ b/src/main/java/org/scijava/module/event/ModulePostprocessEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/event/ModulePreprocessEvent.java b/src/main/java/org/scijava/module/event/ModulePreprocessEvent.java
index 0eedb7c05..7efdc11c7 100644
--- a/src/main/java/org/scijava/module/event/ModulePreprocessEvent.java
+++ b/src/main/java/org/scijava/module/event/ModulePreprocessEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/event/ModuleProcessEvent.java b/src/main/java/org/scijava/module/event/ModuleProcessEvent.java
index 8dba30973..f5ac20fe8 100644
--- a/src/main/java/org/scijava/module/event/ModuleProcessEvent.java
+++ b/src/main/java/org/scijava/module/event/ModuleProcessEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/event/ModuleStartedEvent.java b/src/main/java/org/scijava/module/event/ModuleStartedEvent.java
index cbe7f0518..2b8f59393 100644
--- a/src/main/java/org/scijava/module/event/ModuleStartedEvent.java
+++ b/src/main/java/org/scijava/module/event/ModuleStartedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/event/ModulesAddedEvent.java b/src/main/java/org/scijava/module/event/ModulesAddedEvent.java
index 8ef3dcf44..30107c4e7 100644
--- a/src/main/java/org/scijava/module/event/ModulesAddedEvent.java
+++ b/src/main/java/org/scijava/module/event/ModulesAddedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/event/ModulesListEvent.java b/src/main/java/org/scijava/module/event/ModulesListEvent.java
index 7fba52f93..051edef8d 100644
--- a/src/main/java/org/scijava/module/event/ModulesListEvent.java
+++ b/src/main/java/org/scijava/module/event/ModulesListEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/event/ModulesRemovedEvent.java b/src/main/java/org/scijava/module/event/ModulesRemovedEvent.java
index 87b43a956..495f9e7e2 100644
--- a/src/main/java/org/scijava/module/event/ModulesRemovedEvent.java
+++ b/src/main/java/org/scijava/module/event/ModulesRemovedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/event/ModulesUpdatedEvent.java b/src/main/java/org/scijava/module/event/ModulesUpdatedEvent.java
index 610ad5a94..df5a9065d 100644
--- a/src/main/java/org/scijava/module/event/ModulesUpdatedEvent.java
+++ b/src/main/java/org/scijava/module/event/ModulesUpdatedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/AbstractPostprocessorPlugin.java b/src/main/java/org/scijava/module/process/AbstractPostprocessorPlugin.java
index 8242389bb..6e786753b 100644
--- a/src/main/java/org/scijava/module/process/AbstractPostprocessorPlugin.java
+++ b/src/main/java/org/scijava/module/process/AbstractPostprocessorPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/AbstractPreprocessorPlugin.java b/src/main/java/org/scijava/module/process/AbstractPreprocessorPlugin.java
index 93d3726a2..b9cb5de9d 100644
--- a/src/main/java/org/scijava/module/process/AbstractPreprocessorPlugin.java
+++ b/src/main/java/org/scijava/module/process/AbstractPreprocessorPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/AbstractSingleInputPreprocessor.java b/src/main/java/org/scijava/module/process/AbstractSingleInputPreprocessor.java
index 1fcdc7403..63e07cd2b 100644
--- a/src/main/java/org/scijava/module/process/AbstractSingleInputPreprocessor.java
+++ b/src/main/java/org/scijava/module/process/AbstractSingleInputPreprocessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/CheckInputsPreprocessor.java b/src/main/java/org/scijava/module/process/CheckInputsPreprocessor.java
index d5323ad2f..8bbfac881 100644
--- a/src/main/java/org/scijava/module/process/CheckInputsPreprocessor.java
+++ b/src/main/java/org/scijava/module/process/CheckInputsPreprocessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/DebugPostprocessor.java b/src/main/java/org/scijava/module/process/DebugPostprocessor.java
index 1927c68aa..e614afada 100644
--- a/src/main/java/org/scijava/module/process/DebugPostprocessor.java
+++ b/src/main/java/org/scijava/module/process/DebugPostprocessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/DebugPreprocessor.java b/src/main/java/org/scijava/module/process/DebugPreprocessor.java
index 69e9a0099..15f6afe1f 100644
--- a/src/main/java/org/scijava/module/process/DebugPreprocessor.java
+++ b/src/main/java/org/scijava/module/process/DebugPreprocessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/DefaultValuePreprocessor.java b/src/main/java/org/scijava/module/process/DefaultValuePreprocessor.java
index 7239743f9..fed93f7e9 100644
--- a/src/main/java/org/scijava/module/process/DefaultValuePreprocessor.java
+++ b/src/main/java/org/scijava/module/process/DefaultValuePreprocessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/GatewayPreprocessor.java b/src/main/java/org/scijava/module/process/GatewayPreprocessor.java
index 86ad0eb5e..b3889d479 100644
--- a/src/main/java/org/scijava/module/process/GatewayPreprocessor.java
+++ b/src/main/java/org/scijava/module/process/GatewayPreprocessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/InitPreprocessor.java b/src/main/java/org/scijava/module/process/InitPreprocessor.java
index 2ca0e647b..d135614d6 100644
--- a/src/main/java/org/scijava/module/process/InitPreprocessor.java
+++ b/src/main/java/org/scijava/module/process/InitPreprocessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/LoadInputsPreprocessor.java b/src/main/java/org/scijava/module/process/LoadInputsPreprocessor.java
index 62b6ad5bd..eb405b424 100644
--- a/src/main/java/org/scijava/module/process/LoadInputsPreprocessor.java
+++ b/src/main/java/org/scijava/module/process/LoadInputsPreprocessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/LoggerPreprocessor.java b/src/main/java/org/scijava/module/process/LoggerPreprocessor.java
index 6145337ac..b096c5593 100644
--- a/src/main/java/org/scijava/module/process/LoggerPreprocessor.java
+++ b/src/main/java/org/scijava/module/process/LoggerPreprocessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -29,6 +29,7 @@
package org.scijava.module.process;
+import org.scijava.Priority;
import org.scijava.log.LogService;
import org.scijava.log.Logger;
import org.scijava.module.Module;
@@ -44,7 +45,7 @@
*
* @author Matthias Arzt
*/
-@Plugin(type = PreprocessorPlugin.class)
+@Plugin(type = PreprocessorPlugin.class, priority = Priority.VERY_HIGH)
public class LoggerPreprocessor extends AbstractPreprocessorPlugin {
@Parameter(required = false)
diff --git a/src/main/java/org/scijava/module/process/ModulePostprocessor.java b/src/main/java/org/scijava/module/process/ModulePostprocessor.java
index a64b52723..50a82900e 100644
--- a/src/main/java/org/scijava/module/process/ModulePostprocessor.java
+++ b/src/main/java/org/scijava/module/process/ModulePostprocessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/ModulePreprocessor.java b/src/main/java/org/scijava/module/process/ModulePreprocessor.java
index 293610033..ee9d2af22 100644
--- a/src/main/java/org/scijava/module/process/ModulePreprocessor.java
+++ b/src/main/java/org/scijava/module/process/ModulePreprocessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/ModuleProcessor.java b/src/main/java/org/scijava/module/process/ModuleProcessor.java
index c14c275b3..605194d03 100644
--- a/src/main/java/org/scijava/module/process/ModuleProcessor.java
+++ b/src/main/java/org/scijava/module/process/ModuleProcessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/PostprocessorPlugin.java b/src/main/java/org/scijava/module/process/PostprocessorPlugin.java
index 07081b6c9..a010e0a6f 100644
--- a/src/main/java/org/scijava/module/process/PostprocessorPlugin.java
+++ b/src/main/java/org/scijava/module/process/PostprocessorPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/PreprocessorPlugin.java b/src/main/java/org/scijava/module/process/PreprocessorPlugin.java
index 66b10b86a..57ccdc92f 100644
--- a/src/main/java/org/scijava/module/process/PreprocessorPlugin.java
+++ b/src/main/java/org/scijava/module/process/PreprocessorPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/SaveInputsPreprocessor.java b/src/main/java/org/scijava/module/process/SaveInputsPreprocessor.java
index 1998a76d1..8f4596f76 100644
--- a/src/main/java/org/scijava/module/process/SaveInputsPreprocessor.java
+++ b/src/main/java/org/scijava/module/process/SaveInputsPreprocessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/ServicePreprocessor.java b/src/main/java/org/scijava/module/process/ServicePreprocessor.java
index 048f0da82..15ac626c5 100644
--- a/src/main/java/org/scijava/module/process/ServicePreprocessor.java
+++ b/src/main/java/org/scijava/module/process/ServicePreprocessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/process/ValidityPreprocessor.java b/src/main/java/org/scijava/module/process/ValidityPreprocessor.java
index ac86b2020..e1cbdb29e 100644
--- a/src/main/java/org/scijava/module/process/ValidityPreprocessor.java
+++ b/src/main/java/org/scijava/module/process/ValidityPreprocessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/module/run/ModuleCodeRunner.java b/src/main/java/org/scijava/module/run/ModuleCodeRunner.java
index 2ee78144c..0369dee67 100644
--- a/src/main/java/org/scijava/module/run/ModuleCodeRunner.java
+++ b/src/main/java/org/scijava/module/run/ModuleCodeRunner.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/object/DefaultObjectService.java b/src/main/java/org/scijava/object/DefaultObjectService.java
index 0b112b662..885f2025c 100644
--- a/src/main/java/org/scijava/object/DefaultObjectService.java
+++ b/src/main/java/org/scijava/object/DefaultObjectService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/object/LazyObjects.java b/src/main/java/org/scijava/object/LazyObjects.java
index 3fc476f79..3676085bb 100644
--- a/src/main/java/org/scijava/object/LazyObjects.java
+++ b/src/main/java/org/scijava/object/LazyObjects.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/object/NamedObjectIndex.java b/src/main/java/org/scijava/object/NamedObjectIndex.java
index 9cd2aeae6..0d807d166 100644
--- a/src/main/java/org/scijava/object/NamedObjectIndex.java
+++ b/src/main/java/org/scijava/object/NamedObjectIndex.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/object/ObjectIndex.java b/src/main/java/org/scijava/object/ObjectIndex.java
index e97521043..5eb81dde1 100644
--- a/src/main/java/org/scijava/object/ObjectIndex.java
+++ b/src/main/java/org/scijava/object/ObjectIndex.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/object/ObjectService.java b/src/main/java/org/scijava/object/ObjectService.java
index 392e476d5..fac395e5d 100644
--- a/src/main/java/org/scijava/object/ObjectService.java
+++ b/src/main/java/org/scijava/object/ObjectService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/object/SortedObjectIndex.java b/src/main/java/org/scijava/object/SortedObjectIndex.java
index 77b231a0c..a9d2d1f21 100644
--- a/src/main/java/org/scijava/object/SortedObjectIndex.java
+++ b/src/main/java/org/scijava/object/SortedObjectIndex.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/object/event/ListEvent.java b/src/main/java/org/scijava/object/event/ListEvent.java
index ecf3103e9..e7e5214f7 100644
--- a/src/main/java/org/scijava/object/event/ListEvent.java
+++ b/src/main/java/org/scijava/object/event/ListEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/object/event/ObjectCreatedEvent.java b/src/main/java/org/scijava/object/event/ObjectCreatedEvent.java
index 7f0615f4c..0cbd3dad0 100644
--- a/src/main/java/org/scijava/object/event/ObjectCreatedEvent.java
+++ b/src/main/java/org/scijava/object/event/ObjectCreatedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/object/event/ObjectDeletedEvent.java b/src/main/java/org/scijava/object/event/ObjectDeletedEvent.java
index 47fc3c88c..793a20c02 100644
--- a/src/main/java/org/scijava/object/event/ObjectDeletedEvent.java
+++ b/src/main/java/org/scijava/object/event/ObjectDeletedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/object/event/ObjectEvent.java b/src/main/java/org/scijava/object/event/ObjectEvent.java
index 80816a27b..7b1370612 100644
--- a/src/main/java/org/scijava/object/event/ObjectEvent.java
+++ b/src/main/java/org/scijava/object/event/ObjectEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/object/event/ObjectModifiedEvent.java b/src/main/java/org/scijava/object/event/ObjectModifiedEvent.java
index 966294653..6e51bb9d2 100644
--- a/src/main/java/org/scijava/object/event/ObjectModifiedEvent.java
+++ b/src/main/java/org/scijava/object/event/ObjectModifiedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/object/event/ObjectsAddedEvent.java b/src/main/java/org/scijava/object/event/ObjectsAddedEvent.java
index 9da819a74..c4ce0e854 100644
--- a/src/main/java/org/scijava/object/event/ObjectsAddedEvent.java
+++ b/src/main/java/org/scijava/object/event/ObjectsAddedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/object/event/ObjectsListEvent.java b/src/main/java/org/scijava/object/event/ObjectsListEvent.java
index f9880b3e6..9bab39b51 100644
--- a/src/main/java/org/scijava/object/event/ObjectsListEvent.java
+++ b/src/main/java/org/scijava/object/event/ObjectsListEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/object/event/ObjectsRemovedEvent.java b/src/main/java/org/scijava/object/event/ObjectsRemovedEvent.java
index 4a0872e99..c042a73f8 100644
--- a/src/main/java/org/scijava/object/event/ObjectsRemovedEvent.java
+++ b/src/main/java/org/scijava/object/event/ObjectsRemovedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/options/DefaultOptionsService.java b/src/main/java/org/scijava/options/DefaultOptionsService.java
index 7e44fb84a..aa6792276 100644
--- a/src/main/java/org/scijava/options/DefaultOptionsService.java
+++ b/src/main/java/org/scijava/options/DefaultOptionsService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/options/OptionsPlugin.java b/src/main/java/org/scijava/options/OptionsPlugin.java
index bda0f4df2..24208055c 100644
--- a/src/main/java/org/scijava/options/OptionsPlugin.java
+++ b/src/main/java/org/scijava/options/OptionsPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/options/OptionsService.java b/src/main/java/org/scijava/options/OptionsService.java
index 72ead76f2..6e659e1c9 100644
--- a/src/main/java/org/scijava/options/OptionsService.java
+++ b/src/main/java/org/scijava/options/OptionsService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/options/event/OptionsEvent.java b/src/main/java/org/scijava/options/event/OptionsEvent.java
index 48c53fffc..9ecea6af8 100644
--- a/src/main/java/org/scijava/options/event/OptionsEvent.java
+++ b/src/main/java/org/scijava/options/event/OptionsEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/parse/DefaultParseService.java b/src/main/java/org/scijava/parse/DefaultParseService.java
index 53bdbe46a..0924ab884 100644
--- a/src/main/java/org/scijava/parse/DefaultParseService.java
+++ b/src/main/java/org/scijava/parse/DefaultParseService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/parse/Item.java b/src/main/java/org/scijava/parse/Item.java
index efb86a527..416538777 100644
--- a/src/main/java/org/scijava/parse/Item.java
+++ b/src/main/java/org/scijava/parse/Item.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/parse/Items.java b/src/main/java/org/scijava/parse/Items.java
index a54117481..0b3b6becb 100644
--- a/src/main/java/org/scijava/parse/Items.java
+++ b/src/main/java/org/scijava/parse/Items.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/parse/ParseService.java b/src/main/java/org/scijava/parse/ParseService.java
index de88860dd..fe7ff2946 100644
--- a/src/main/java/org/scijava/parse/ParseService.java
+++ b/src/main/java/org/scijava/parse/ParseService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/AbstractPlatform.java b/src/main/java/org/scijava/platform/AbstractPlatform.java
index 6c8cfa5bc..9005f3024 100644
--- a/src/main/java/org/scijava/platform/AbstractPlatform.java
+++ b/src/main/java/org/scijava/platform/AbstractPlatform.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/AppEventService.java b/src/main/java/org/scijava/platform/AppEventService.java
index 26d2b4555..6227d6563 100644
--- a/src/main/java/org/scijava/platform/AppEventService.java
+++ b/src/main/java/org/scijava/platform/AppEventService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/DefaultAppEventService.java b/src/main/java/org/scijava/platform/DefaultAppEventService.java
index 2101d8c04..07809297d 100644
--- a/src/main/java/org/scijava/platform/DefaultAppEventService.java
+++ b/src/main/java/org/scijava/platform/DefaultAppEventService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/DefaultPlatform.java b/src/main/java/org/scijava/platform/DefaultPlatform.java
index 6d61317fe..18473f650 100644
--- a/src/main/java/org/scijava/platform/DefaultPlatform.java
+++ b/src/main/java/org/scijava/platform/DefaultPlatform.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -33,6 +33,8 @@
import java.net.URL;
import org.scijava.Priority;
+import org.scijava.log.LogService;
+import org.scijava.plugin.Parameter;
import org.scijava.plugin.Plugin;
/**
@@ -44,6 +46,9 @@
@Plugin(type = Platform.class, name = "Default", priority = Priority.VERY_LOW)
public class DefaultPlatform extends AbstractPlatform {
+ @Parameter(required = false)
+ private LogService log;
+
// -- PlatformHandler methods --
/**
@@ -66,9 +71,14 @@ public void open(final URL url) throws IOException {
try {
final int exitCode = getPlatformService().exec(browser, url.toString());
if (exitCode == 0) return;
+ else if (log != null) {
+ log.debug("Command '" + browser +
+ "' failed with exit code " + exitCode);
+ }
}
catch (final IOException e) {
// browser executable was invalid; try the next one
+ if (log != null) log.debug("Command '" + browser + "' failed", e);
}
}
throw new IOException("Could not open " + url);
diff --git a/src/main/java/org/scijava/platform/DefaultPlatformService.java b/src/main/java/org/scijava/platform/DefaultPlatformService.java
index 2a1c671ae..bb8c962a6 100644
--- a/src/main/java/org/scijava/platform/DefaultPlatformService.java
+++ b/src/main/java/org/scijava/platform/DefaultPlatformService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/Platform.java b/src/main/java/org/scijava/platform/Platform.java
index 3a663bb85..31cc2e86a 100644
--- a/src/main/java/org/scijava/platform/Platform.java
+++ b/src/main/java/org/scijava/platform/Platform.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/PlatformService.java b/src/main/java/org/scijava/platform/PlatformService.java
index 2f771bd35..ff66f8939 100644
--- a/src/main/java/org/scijava/platform/PlatformService.java
+++ b/src/main/java/org/scijava/platform/PlatformService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/event/AppAboutEvent.java b/src/main/java/org/scijava/platform/event/AppAboutEvent.java
index 46eed9b31..cd39d4764 100644
--- a/src/main/java/org/scijava/platform/event/AppAboutEvent.java
+++ b/src/main/java/org/scijava/platform/event/AppAboutEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/event/AppFocusEvent.java b/src/main/java/org/scijava/platform/event/AppFocusEvent.java
index 36d5605a0..e18e88a14 100644
--- a/src/main/java/org/scijava/platform/event/AppFocusEvent.java
+++ b/src/main/java/org/scijava/platform/event/AppFocusEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/event/AppMenusCreatedEvent.java b/src/main/java/org/scijava/platform/event/AppMenusCreatedEvent.java
index 1e9dd3f9e..3f8b80e0f 100644
--- a/src/main/java/org/scijava/platform/event/AppMenusCreatedEvent.java
+++ b/src/main/java/org/scijava/platform/event/AppMenusCreatedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/event/AppOpenFilesEvent.java b/src/main/java/org/scijava/platform/event/AppOpenFilesEvent.java
index 5b3bdcde1..cf42e0a73 100644
--- a/src/main/java/org/scijava/platform/event/AppOpenFilesEvent.java
+++ b/src/main/java/org/scijava/platform/event/AppOpenFilesEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/event/AppPreferencesEvent.java b/src/main/java/org/scijava/platform/event/AppPreferencesEvent.java
index 2b4883129..f6cf5ce81 100644
--- a/src/main/java/org/scijava/platform/event/AppPreferencesEvent.java
+++ b/src/main/java/org/scijava/platform/event/AppPreferencesEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/event/AppPrintEvent.java b/src/main/java/org/scijava/platform/event/AppPrintEvent.java
index 013a70e79..2cfd3a56e 100644
--- a/src/main/java/org/scijava/platform/event/AppPrintEvent.java
+++ b/src/main/java/org/scijava/platform/event/AppPrintEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/event/AppQuitEvent.java b/src/main/java/org/scijava/platform/event/AppQuitEvent.java
index de8d9be40..0b5f5f1ac 100644
--- a/src/main/java/org/scijava/platform/event/AppQuitEvent.java
+++ b/src/main/java/org/scijava/platform/event/AppQuitEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/event/AppReOpenEvent.java b/src/main/java/org/scijava/platform/event/AppReOpenEvent.java
index 907e83148..a9db284a5 100644
--- a/src/main/java/org/scijava/platform/event/AppReOpenEvent.java
+++ b/src/main/java/org/scijava/platform/event/AppReOpenEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/event/AppScreenSleepEvent.java b/src/main/java/org/scijava/platform/event/AppScreenSleepEvent.java
index fcedfd3a3..d499a62db 100644
--- a/src/main/java/org/scijava/platform/event/AppScreenSleepEvent.java
+++ b/src/main/java/org/scijava/platform/event/AppScreenSleepEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/event/AppSleepEvent.java b/src/main/java/org/scijava/platform/event/AppSleepEvent.java
index 776b80fba..5ba427317 100644
--- a/src/main/java/org/scijava/platform/event/AppSleepEvent.java
+++ b/src/main/java/org/scijava/platform/event/AppSleepEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/event/AppSystemSleepEvent.java b/src/main/java/org/scijava/platform/event/AppSystemSleepEvent.java
index f7c426e3a..9e86cadf2 100644
--- a/src/main/java/org/scijava/platform/event/AppSystemSleepEvent.java
+++ b/src/main/java/org/scijava/platform/event/AppSystemSleepEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/event/AppUserSessionEvent.java b/src/main/java/org/scijava/platform/event/AppUserSessionEvent.java
index e3ee34255..fb202cbc3 100644
--- a/src/main/java/org/scijava/platform/event/AppUserSessionEvent.java
+++ b/src/main/java/org/scijava/platform/event/AppUserSessionEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/event/AppVisibleEvent.java b/src/main/java/org/scijava/platform/event/AppVisibleEvent.java
index 307895791..1b6fd77d2 100644
--- a/src/main/java/org/scijava/platform/event/AppVisibleEvent.java
+++ b/src/main/java/org/scijava/platform/event/AppVisibleEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/platform/event/ApplicationEvent.java b/src/main/java/org/scijava/platform/event/ApplicationEvent.java
index 0b359cd46..da0a2f3a1 100644
--- a/src/main/java/org/scijava/platform/event/ApplicationEvent.java
+++ b/src/main/java/org/scijava/platform/event/ApplicationEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/AbstractHandlerPlugin.java b/src/main/java/org/scijava/plugin/AbstractHandlerPlugin.java
index 3187fcd23..2077a94c0 100644
--- a/src/main/java/org/scijava/plugin/AbstractHandlerPlugin.java
+++ b/src/main/java/org/scijava/plugin/AbstractHandlerPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/AbstractHandlerService.java b/src/main/java/org/scijava/plugin/AbstractHandlerService.java
index 4ede3e5aa..65873e6eb 100644
--- a/src/main/java/org/scijava/plugin/AbstractHandlerService.java
+++ b/src/main/java/org/scijava/plugin/AbstractHandlerService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/AbstractPTService.java b/src/main/java/org/scijava/plugin/AbstractPTService.java
index 7d96d2770..5273d007b 100644
--- a/src/main/java/org/scijava/plugin/AbstractPTService.java
+++ b/src/main/java/org/scijava/plugin/AbstractPTService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/AbstractRichPlugin.java b/src/main/java/org/scijava/plugin/AbstractRichPlugin.java
index 2d53decac..205d8ce8c 100644
--- a/src/main/java/org/scijava/plugin/AbstractRichPlugin.java
+++ b/src/main/java/org/scijava/plugin/AbstractRichPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/AbstractSingletonService.java b/src/main/java/org/scijava/plugin/AbstractSingletonService.java
index c54f26ee5..b7f65c684 100644
--- a/src/main/java/org/scijava/plugin/AbstractSingletonService.java
+++ b/src/main/java/org/scijava/plugin/AbstractSingletonService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/AbstractTypedPlugin.java b/src/main/java/org/scijava/plugin/AbstractTypedPlugin.java
index 8d9e4a1f3..a9a12fb89 100644
--- a/src/main/java/org/scijava/plugin/AbstractTypedPlugin.java
+++ b/src/main/java/org/scijava/plugin/AbstractTypedPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/AbstractTypedService.java b/src/main/java/org/scijava/plugin/AbstractTypedService.java
index 17ea8f400..c747223f3 100644
--- a/src/main/java/org/scijava/plugin/AbstractTypedService.java
+++ b/src/main/java/org/scijava/plugin/AbstractTypedService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/AbstractWrapperPlugin.java b/src/main/java/org/scijava/plugin/AbstractWrapperPlugin.java
index 26fcc5e47..4a8d11412 100644
--- a/src/main/java/org/scijava/plugin/AbstractWrapperPlugin.java
+++ b/src/main/java/org/scijava/plugin/AbstractWrapperPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/AbstractWrapperService.java b/src/main/java/org/scijava/plugin/AbstractWrapperService.java
index 516ad9d69..9bd224855 100644
--- a/src/main/java/org/scijava/plugin/AbstractWrapperService.java
+++ b/src/main/java/org/scijava/plugin/AbstractWrapperService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/Attr.java b/src/main/java/org/scijava/plugin/Attr.java
index d45a4f0b0..1dce1f4d7 100644
--- a/src/main/java/org/scijava/plugin/Attr.java
+++ b/src/main/java/org/scijava/plugin/Attr.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/DefaultPluginFinder.java b/src/main/java/org/scijava/plugin/DefaultPluginFinder.java
index 99fc8fd18..bd3a0eb08 100644
--- a/src/main/java/org/scijava/plugin/DefaultPluginFinder.java
+++ b/src/main/java/org/scijava/plugin/DefaultPluginFinder.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/DefaultPluginService.java b/src/main/java/org/scijava/plugin/DefaultPluginService.java
index 02b905f56..096e75c92 100644
--- a/src/main/java/org/scijava/plugin/DefaultPluginService.java
+++ b/src/main/java/org/scijava/plugin/DefaultPluginService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/HandlerPlugin.java b/src/main/java/org/scijava/plugin/HandlerPlugin.java
index b511aab11..8abcba382 100644
--- a/src/main/java/org/scijava/plugin/HandlerPlugin.java
+++ b/src/main/java/org/scijava/plugin/HandlerPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/HandlerService.java b/src/main/java/org/scijava/plugin/HandlerService.java
index 1a2bfa119..dec2d71b5 100644
--- a/src/main/java/org/scijava/plugin/HandlerService.java
+++ b/src/main/java/org/scijava/plugin/HandlerService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/HasPluginInfo.java b/src/main/java/org/scijava/plugin/HasPluginInfo.java
index 19c3da732..622429d98 100644
--- a/src/main/java/org/scijava/plugin/HasPluginInfo.java
+++ b/src/main/java/org/scijava/plugin/HasPluginInfo.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/Menu.java b/src/main/java/org/scijava/plugin/Menu.java
index 0c00e546b..ce861c6b6 100644
--- a/src/main/java/org/scijava/plugin/Menu.java
+++ b/src/main/java/org/scijava/plugin/Menu.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/PTService.java b/src/main/java/org/scijava/plugin/PTService.java
index 4feb02532..d0e61a997 100644
--- a/src/main/java/org/scijava/plugin/PTService.java
+++ b/src/main/java/org/scijava/plugin/PTService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/Parameter.java b/src/main/java/org/scijava/plugin/Parameter.java
index 0a41c094d..edc1da1af 100644
--- a/src/main/java/org/scijava/plugin/Parameter.java
+++ b/src/main/java/org/scijava/plugin/Parameter.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -71,7 +71,7 @@
*
*/
// NB: We use the fully qualified name to work around a javac bug:
- // http://bugs.sun.com/view_bug.do?bug_id=6512707
+ // https://bugs.java.com/view_bug.do?bug_id=6512707
// See:
// http://groups.google.com/group/project-lombok/browse_thread/thread/c5568eb659cab203
ItemIO type() default org.scijava.ItemIO.INPUT;
diff --git a/src/main/java/org/scijava/plugin/Plugin.java b/src/main/java/org/scijava/plugin/Plugin.java
index a1f7af866..cd1701881 100644
--- a/src/main/java/org/scijava/plugin/Plugin.java
+++ b/src/main/java/org/scijava/plugin/Plugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/PluginFinder.java b/src/main/java/org/scijava/plugin/PluginFinder.java
index 0b9ff441e..9f193a90e 100644
--- a/src/main/java/org/scijava/plugin/PluginFinder.java
+++ b/src/main/java/org/scijava/plugin/PluginFinder.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/PluginIndex.java b/src/main/java/org/scijava/plugin/PluginIndex.java
index 73763ef03..ea3aa8fdc 100644
--- a/src/main/java/org/scijava/plugin/PluginIndex.java
+++ b/src/main/java/org/scijava/plugin/PluginIndex.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -88,7 +88,7 @@ public PluginIndex() {
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
public PluginIndex(final PluginFinder pluginFinder) {
- // NB: See: http://stackoverflow.com/questions/4765520/
+ // NB: See: https://stackoverflow.com/questions/4765520/
super((Class) PluginInfo.class);
this.pluginFinder = pluginFinder;
}
diff --git a/src/main/java/org/scijava/plugin/PluginInfo.java b/src/main/java/org/scijava/plugin/PluginInfo.java
index a9e4b5e09..85bab5954 100644
--- a/src/main/java/org/scijava/plugin/PluginInfo.java
+++ b/src/main/java/org/scijava/plugin/PluginInfo.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/PluginService.java b/src/main/java/org/scijava/plugin/PluginService.java
index 07f44a6ca..644268b87 100644
--- a/src/main/java/org/scijava/plugin/PluginService.java
+++ b/src/main/java/org/scijava/plugin/PluginService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/RichPlugin.java b/src/main/java/org/scijava/plugin/RichPlugin.java
index d649eb5aa..891cc7822 100644
--- a/src/main/java/org/scijava/plugin/RichPlugin.java
+++ b/src/main/java/org/scijava/plugin/RichPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/SciJavaPlugin.java b/src/main/java/org/scijava/plugin/SciJavaPlugin.java
index ff4bd3c7a..97675e8bc 100644
--- a/src/main/java/org/scijava/plugin/SciJavaPlugin.java
+++ b/src/main/java/org/scijava/plugin/SciJavaPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/SingletonPlugin.java b/src/main/java/org/scijava/plugin/SingletonPlugin.java
index b26ee37cc..72b5da303 100644
--- a/src/main/java/org/scijava/plugin/SingletonPlugin.java
+++ b/src/main/java/org/scijava/plugin/SingletonPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/SingletonService.java b/src/main/java/org/scijava/plugin/SingletonService.java
index 07c2ff091..a60622eac 100644
--- a/src/main/java/org/scijava/plugin/SingletonService.java
+++ b/src/main/java/org/scijava/plugin/SingletonService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/SortablePlugin.java b/src/main/java/org/scijava/plugin/SortablePlugin.java
index e3ab8e244..e7f005db9 100644
--- a/src/main/java/org/scijava/plugin/SortablePlugin.java
+++ b/src/main/java/org/scijava/plugin/SortablePlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/TypedPlugin.java b/src/main/java/org/scijava/plugin/TypedPlugin.java
index 26ae5468e..31153089a 100644
--- a/src/main/java/org/scijava/plugin/TypedPlugin.java
+++ b/src/main/java/org/scijava/plugin/TypedPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/TypedService.java b/src/main/java/org/scijava/plugin/TypedService.java
index 26f1c60bf..74701f46c 100644
--- a/src/main/java/org/scijava/plugin/TypedService.java
+++ b/src/main/java/org/scijava/plugin/TypedService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/WrapperPlugin.java b/src/main/java/org/scijava/plugin/WrapperPlugin.java
index d867aeef8..651bf634e 100644
--- a/src/main/java/org/scijava/plugin/WrapperPlugin.java
+++ b/src/main/java/org/scijava/plugin/WrapperPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/WrapperService.java b/src/main/java/org/scijava/plugin/WrapperService.java
index 2377a9fef..4274f16e8 100644
--- a/src/main/java/org/scijava/plugin/WrapperService.java
+++ b/src/main/java/org/scijava/plugin/WrapperService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/event/PluginsAddedEvent.java b/src/main/java/org/scijava/plugin/event/PluginsAddedEvent.java
index cae5e3792..edfc5b32e 100644
--- a/src/main/java/org/scijava/plugin/event/PluginsAddedEvent.java
+++ b/src/main/java/org/scijava/plugin/event/PluginsAddedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/event/PluginsListEvent.java b/src/main/java/org/scijava/plugin/event/PluginsListEvent.java
index 927d76bee..af6bf4dc3 100644
--- a/src/main/java/org/scijava/plugin/event/PluginsListEvent.java
+++ b/src/main/java/org/scijava/plugin/event/PluginsListEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/plugin/event/PluginsRemovedEvent.java b/src/main/java/org/scijava/plugin/event/PluginsRemovedEvent.java
index f46d54bf9..baf9961a3 100644
--- a/src/main/java/org/scijava/plugin/event/PluginsRemovedEvent.java
+++ b/src/main/java/org/scijava/plugin/event/PluginsRemovedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/prefs/AbstractPrefService.java b/src/main/java/org/scijava/prefs/AbstractPrefService.java
index 8fc849c20..052603404 100644
--- a/src/main/java/org/scijava/prefs/AbstractPrefService.java
+++ b/src/main/java/org/scijava/prefs/AbstractPrefService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/prefs/DefaultPrefService.java b/src/main/java/org/scijava/prefs/DefaultPrefService.java
index 76a688924..3c192f62b 100644
--- a/src/main/java/org/scijava/prefs/DefaultPrefService.java
+++ b/src/main/java/org/scijava/prefs/DefaultPrefService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/prefs/PrefService.java b/src/main/java/org/scijava/prefs/PrefService.java
index 9e787f436..98115b323 100644
--- a/src/main/java/org/scijava/prefs/PrefService.java
+++ b/src/main/java/org/scijava/prefs/PrefService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/run/AbstractCodeRunner.java b/src/main/java/org/scijava/run/AbstractCodeRunner.java
index 37ebab4cb..a10bd9205 100644
--- a/src/main/java/org/scijava/run/AbstractCodeRunner.java
+++ b/src/main/java/org/scijava/run/AbstractCodeRunner.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/run/CodeRunner.java b/src/main/java/org/scijava/run/CodeRunner.java
index 13062df91..2efa316e2 100644
--- a/src/main/java/org/scijava/run/CodeRunner.java
+++ b/src/main/java/org/scijava/run/CodeRunner.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/run/DefaultRunService.java b/src/main/java/org/scijava/run/DefaultRunService.java
index cb9a7249e..68239a4d7 100644
--- a/src/main/java/org/scijava/run/DefaultRunService.java
+++ b/src/main/java/org/scijava/run/DefaultRunService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/run/RunService.java b/src/main/java/org/scijava/run/RunService.java
index e0f8de3bb..738cfb078 100644
--- a/src/main/java/org/scijava/run/RunService.java
+++ b/src/main/java/org/scijava/run/RunService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/run/console/RunArgument.java b/src/main/java/org/scijava/run/console/RunArgument.java
index ba056a6e8..028440a5e 100644
--- a/src/main/java/org/scijava/run/console/RunArgument.java
+++ b/src/main/java/org/scijava/run/console/RunArgument.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/AbstractAutoCompleter.java b/src/main/java/org/scijava/script/AbstractAutoCompleter.java
index b8368dbff..ae255f5a2 100644
--- a/src/main/java/org/scijava/script/AbstractAutoCompleter.java
+++ b/src/main/java/org/scijava/script/AbstractAutoCompleter.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/AbstractScriptContext.java b/src/main/java/org/scijava/script/AbstractScriptContext.java
index abd258195..3f69d608a 100644
--- a/src/main/java/org/scijava/script/AbstractScriptContext.java
+++ b/src/main/java/org/scijava/script/AbstractScriptContext.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/AbstractScriptEngine.java b/src/main/java/org/scijava/script/AbstractScriptEngine.java
index f306ee488..c64f967c3 100644
--- a/src/main/java/org/scijava/script/AbstractScriptEngine.java
+++ b/src/main/java/org/scijava/script/AbstractScriptEngine.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/AbstractScriptHeader.java b/src/main/java/org/scijava/script/AbstractScriptHeader.java
index 41b3185bc..6dcf2650c 100644
--- a/src/main/java/org/scijava/script/AbstractScriptHeader.java
+++ b/src/main/java/org/scijava/script/AbstractScriptHeader.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/AbstractScriptLanguage.java b/src/main/java/org/scijava/script/AbstractScriptLanguage.java
index 0f65a99c2..6f048fc89 100644
--- a/src/main/java/org/scijava/script/AbstractScriptLanguage.java
+++ b/src/main/java/org/scijava/script/AbstractScriptLanguage.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/AdaptedScriptEngine.java b/src/main/java/org/scijava/script/AdaptedScriptEngine.java
index 39c8012a3..14e0d5a72 100644
--- a/src/main/java/org/scijava/script/AdaptedScriptEngine.java
+++ b/src/main/java/org/scijava/script/AdaptedScriptEngine.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/AdaptedScriptLanguage.java b/src/main/java/org/scijava/script/AdaptedScriptLanguage.java
index ad952d54d..695c214a9 100644
--- a/src/main/java/org/scijava/script/AdaptedScriptLanguage.java
+++ b/src/main/java/org/scijava/script/AdaptedScriptLanguage.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/AutoCompleter.java b/src/main/java/org/scijava/script/AutoCompleter.java
index f56ec50fb..334addd58 100644
--- a/src/main/java/org/scijava/script/AutoCompleter.java
+++ b/src/main/java/org/scijava/script/AutoCompleter.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/AutoCompletionResult.java b/src/main/java/org/scijava/script/AutoCompletionResult.java
index 89ae99097..8f5ac4d5c 100644
--- a/src/main/java/org/scijava/script/AutoCompletionResult.java
+++ b/src/main/java/org/scijava/script/AutoCompletionResult.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/CodeGenerator.java b/src/main/java/org/scijava/script/CodeGenerator.java
index 7e95f1e78..894ce8f54 100644
--- a/src/main/java/org/scijava/script/CodeGenerator.java
+++ b/src/main/java/org/scijava/script/CodeGenerator.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/CodeGeneratorJava.java b/src/main/java/org/scijava/script/CodeGeneratorJava.java
index 7f75c39fd..84e9e09c1 100644
--- a/src/main/java/org/scijava/script/CodeGeneratorJava.java
+++ b/src/main/java/org/scijava/script/CodeGeneratorJava.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/DefaultAutoCompleter.java b/src/main/java/org/scijava/script/DefaultAutoCompleter.java
index 95bcc94c0..2de11644b 100644
--- a/src/main/java/org/scijava/script/DefaultAutoCompleter.java
+++ b/src/main/java/org/scijava/script/DefaultAutoCompleter.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/DefaultScriptHeaderService.java b/src/main/java/org/scijava/script/DefaultScriptHeaderService.java
index 39941978e..284479134 100644
--- a/src/main/java/org/scijava/script/DefaultScriptHeaderService.java
+++ b/src/main/java/org/scijava/script/DefaultScriptHeaderService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/DefaultScriptInterpreter.java b/src/main/java/org/scijava/script/DefaultScriptInterpreter.java
index 147c141af..d3448d373 100644
--- a/src/main/java/org/scijava/script/DefaultScriptInterpreter.java
+++ b/src/main/java/org/scijava/script/DefaultScriptInterpreter.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -46,7 +46,7 @@
* The default implementation of a {@link ScriptInterpreter}.
*
* Credit to Jason Sachs for the multi-line evaluation (see
- * his post on StackOverflow ).
+ * his post on StackOverflow ).
*
*
* @author Johannes Schindelin
@@ -174,7 +174,7 @@ public Object eval(final String command) throws ScriptException {
* fact that there was a syntax error in the 2nd line.
*
*
- * For further details, see SO
+ * For further details, see SO
* #5584674 .
*
*/
diff --git a/src/main/java/org/scijava/script/DefaultScriptService.java b/src/main/java/org/scijava/script/DefaultScriptService.java
index 188123998..72b2403d3 100644
--- a/src/main/java/org/scijava/script/DefaultScriptService.java
+++ b/src/main/java/org/scijava/script/DefaultScriptService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -385,7 +385,10 @@ private void addAliases(final HashMap> map,
}
private Class[] pluginClasses(final Class type) {
- return pluginService.getPluginsOfType(type).stream().map(info -> {
+ return pluginService.getPluginsOfType(type).stream() //
+ .filter(info -> !info.is("noAlias")) //
+ .map(info ->
+ {
try {
return info.loadClass();
}
diff --git a/src/main/java/org/scijava/script/InvocationObject.java b/src/main/java/org/scijava/script/InvocationObject.java
index a7f373a7c..3d9c0ce55 100644
--- a/src/main/java/org/scijava/script/InvocationObject.java
+++ b/src/main/java/org/scijava/script/InvocationObject.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/ParameterObject.java b/src/main/java/org/scijava/script/ParameterObject.java
index 184fb8209..2f18323b8 100644
--- a/src/main/java/org/scijava/script/ParameterObject.java
+++ b/src/main/java/org/scijava/script/ParameterObject.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/ScriptCLI.java b/src/main/java/org/scijava/script/ScriptCLI.java
new file mode 100644
index 000000000..e20cf8918
--- /dev/null
+++ b/src/main/java/org/scijava/script/ScriptCLI.java
@@ -0,0 +1,169 @@
+/*
+ * #%L
+ * SciJava Common shared library for SciJava software.
+ * %%
+ * Copyright (C) 2009 - 2026 SciJava developers.
+ * %%
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ * #L%
+ */
+
+package org.scijava.script;
+
+import java.io.File;
+import java.io.FileReader;
+import java.io.InputStreamReader;
+import java.io.Reader;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Map.Entry;
+
+import org.scijava.Context;
+import org.scijava.log.LogLevel;
+import org.scijava.log.LogService;
+import org.scijava.module.Module;
+
+/**
+ * A command-line entry point for running SciJava scripts.
+ *
+ * @author Curtis Rueden
+ */
+public class ScriptCLI {
+
+ private static final String USAGE = "" + //
+ "Usage: " + ScriptCLI.class.getSimpleName() + //
+ " [-d] [-h] [-l language] [-o] [-r] /path/to/script [script-args]\n" + //
+ "\n" + //
+ "Options:\n" + //
+ " -d, --debug : enable debug-level log output\n" + //
+ " -h, --help : display this help message\n" + //
+ " -l, --language : specify language of script to execute\n" + //
+ " otherwise, inferred from script extension\n" + //
+ " -o, --print-outputs : print output values\n" + //
+ " -r, --print-return-value : print return value\n" + //
+ "\n" + //
+ "To read from stdin, use a dash (-) symbol for the script path.\n" + //
+ "\n" + //
+ "For script-args, give space-separated key=value pairs,\n" + //
+ "while will be passed in as SciJava script arguments.";
+
+ public static void main(String... args) throws Exception {
+ final Map inputs = new HashMap<>();
+ File file = null;
+ String language = null;
+ boolean printOutputs = false;
+ boolean printReturnValue = false;
+ boolean parsingOptions = true;
+ try (final Context context = new Context()) {
+ // Parse command-line arguments.
+ if (args.length == 0) args = new String[] {"-h"};
+ for (int i = 0; i < args.length; i++) {
+ if (parsingOptions) {
+ // Parse options and filename.
+ if (args[i].equals("-d") || args[i].equals("--debug")) {
+ final LogService log = context.getService(LogService.class);
+ if (log != null) log.setLevel(LogLevel.DEBUG);
+ }
+ else if (args[i].equals("-h") || args[i].equals("--help")) {
+ System.err.println(USAGE);
+ System.exit(1);
+ }
+ else if (i < args.length - 1 && //
+ args[i].equals("-l") || args[i].equals("--language"))
+ {
+ language = args[++i];
+ }
+ else if (args[i].equals("-o") || args[i].equals("--print-outputs")) {
+ printOutputs = true;
+ }
+ else if (args[i].equals("-r") || args[i].equals("--print-return-value")) {
+ printReturnValue = true;
+ }
+ else if (args[i].equals("-")) {
+ // read from stdin
+ parsingOptions = false;
+ }
+ else if (i < args.length - 1 && args[i].equals("--")) {
+ // argument after the -- separator must be the filename.
+ file = new File(args[++i]);
+ parsingOptions = false;
+ }
+ else if (new File(args[i]).exists()) {
+ file = new File(args[i]);
+ parsingOptions = false;
+ }
+ else {
+ System.err.println("Invalid argument: " + args[i]);
+ System.exit(2);
+ }
+ }
+ else {
+ // Parse script arguments.
+ final int equals = args[i].indexOf("=");
+ if (equals < 0) {
+ System.err.println("Invalid argument: " + args[i]);
+ System.exit(3);
+ }
+ final String key = args[i].substring(0, equals);
+ final String val = args[i].substring(equals + 1);
+ inputs.put(key, val);
+ }
+ }
+
+ final ScriptService ss = context.getService(ScriptService.class);
+ if (ss == null) {
+ System.err.println("Error: No script service available.");
+ System.exit(4);
+ }
+ if (file == null && language == null) {
+ System.err.println("Error: Must specify language when using stdin.");
+ System.exit(5);
+ }
+
+ final Module m;
+ if (language == null) {
+ m = ss.run(file, true, inputs).get();
+ }
+ else {
+ ScriptLanguage lang = ss.getLanguageByName(language);
+ if (lang == null) lang = ss.getLanguageByExtension(language);
+ if (lang == null) {
+ System.err.println("Error: Unsupported language: " + language);
+ System.exit(6);
+ }
+ final Reader reader = file == null ? //
+ new InputStreamReader(System.in) : //
+ new FileReader(file);
+ m = ss.run("." + language, reader, true, inputs).get();
+ }
+ if (printOutputs) {
+ for (Entry output : m.getOutputs().entrySet()) {
+ System.out.println(output.getKey() + " = " + output.getValue());
+ }
+ }
+ if (printReturnValue && m instanceof ScriptModule) {
+ System.out.println(((ScriptModule) m).getReturnValue());
+ }
+ }
+ System.exit(0);
+ }
+}
diff --git a/src/main/java/org/scijava/script/ScriptFinder.java b/src/main/java/org/scijava/script/ScriptFinder.java
index 13f3fb37a..89e4c1b16 100644
--- a/src/main/java/org/scijava/script/ScriptFinder.java
+++ b/src/main/java/org/scijava/script/ScriptFinder.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -41,6 +41,7 @@
import org.scijava.AbstractContextual;
import org.scijava.Context;
+import org.scijava.MenuEntry;
import org.scijava.MenuPath;
import org.scijava.log.LogService;
import org.scijava.plugin.Parameter;
@@ -178,8 +179,11 @@ private int createInfos(final List scripts, final Set urls,
// friendlyPath = "File/Import/Movie File..."
// menuPath = File > Import > Movie File...
- // NB: Ignore base-level scripts (not nested in any menu).
- if (menuPath.size() == 1) continue;
+ // Place base-level scripts in the "Plugins>Scripts" submenu
+ if (menuPath.size() == 1){
+ menuPath.add(0, new MenuEntry("Plugins"));
+ menuPath.add(1, new MenuEntry("Scripts"));
+ }
final URL url = scriptMap.get(path);
diff --git a/src/main/java/org/scijava/script/ScriptHeader.java b/src/main/java/org/scijava/script/ScriptHeader.java
index 57ca01749..417551358 100644
--- a/src/main/java/org/scijava/script/ScriptHeader.java
+++ b/src/main/java/org/scijava/script/ScriptHeader.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/ScriptHeaderService.java b/src/main/java/org/scijava/script/ScriptHeaderService.java
index 692869a8f..a58dd7f81 100644
--- a/src/main/java/org/scijava/script/ScriptHeaderService.java
+++ b/src/main/java/org/scijava/script/ScriptHeaderService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/ScriptInfo.java b/src/main/java/org/scijava/script/ScriptInfo.java
index 02b6c46cf..8b9f1734e 100644
--- a/src/main/java/org/scijava/script/ScriptInfo.java
+++ b/src/main/java/org/scijava/script/ScriptInfo.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/ScriptInterpreter.java b/src/main/java/org/scijava/script/ScriptInterpreter.java
index df59b6a36..b48ad3254 100644
--- a/src/main/java/org/scijava/script/ScriptInterpreter.java
+++ b/src/main/java/org/scijava/script/ScriptInterpreter.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/ScriptLanguage.java b/src/main/java/org/scijava/script/ScriptLanguage.java
index e8c1be0cc..af1c27fc5 100644
--- a/src/main/java/org/scijava/script/ScriptLanguage.java
+++ b/src/main/java/org/scijava/script/ScriptLanguage.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/ScriptLanguageIndex.java b/src/main/java/org/scijava/script/ScriptLanguageIndex.java
index 728c20831..b9e07d602 100644
--- a/src/main/java/org/scijava/script/ScriptLanguageIndex.java
+++ b/src/main/java/org/scijava/script/ScriptLanguageIndex.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -146,8 +146,8 @@ private boolean put(final String type, final Map map,
// Conflicting value; behavior depends on mode.
if (gently) {
// Do not overwrite the previous value.
- if (log != null && log.isWarn()) {
- log.warn(overwriteMessage(false, type, key, value, existing));
+ if (log != null && log.isDebug()) {
+ log.debug(overwriteMessage(false, type, key, value, existing));
}
return false;
}
diff --git a/src/main/java/org/scijava/script/ScriptModule.java b/src/main/java/org/scijava/script/ScriptModule.java
index f05cbc7ed..87fc5fb0d 100644
--- a/src/main/java/org/scijava/script/ScriptModule.java
+++ b/src/main/java/org/scijava/script/ScriptModule.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -102,7 +102,16 @@ public void setErrorWriter(final Writer error) {
/** Gets the script engine used to execute the script. */
public ScriptEngine getEngine() {
if (scriptEngine == null) {
- scriptEngine = getInfo().getLanguage().getScriptEngine();
+ final ScriptInfo scriptInfo = getInfo();
+ if (scriptInfo == null) {
+ throw new IllegalArgumentException("Invalid script");
+ }
+ final ScriptLanguage scriptLang = scriptInfo.getLanguage();
+ if (scriptLang == null) {
+ throw new IllegalArgumentException(
+ "No compatible script language available");
+ }
+ scriptEngine = scriptLang.getScriptEngine();
}
return scriptEngine;
}
diff --git a/src/main/java/org/scijava/script/ScriptREPL.java b/src/main/java/org/scijava/script/ScriptREPL.java
index 9c5be1528..ec9e088c4 100644
--- a/src/main/java/org/scijava/script/ScriptREPL.java
+++ b/src/main/java/org/scijava/script/ScriptREPL.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -30,6 +30,7 @@
package org.scijava.script;
import java.io.BufferedReader;
+import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
@@ -38,6 +39,8 @@
import java.lang.reflect.Constructor;
import java.util.ArrayList;
import java.util.List;
+import java.util.function.Consumer;
+import java.util.function.Supplier;
import javax.script.Bindings;
import javax.script.ScriptException;
@@ -67,9 +70,9 @@ public class ScriptREPL {
@Parameter(required = false)
private PluginService pluginService;
- private final PrintStream out;
+ private final Consumer out;
- private String languagePreference = null;
+ private String languagePreference;
/** List of interpreter-friendly script languages. */
private List languages;
@@ -84,19 +87,26 @@ public ScriptREPL(final Context context) {
this(context, System.out);
}
+ public ScriptREPL(final Context context, final String language) {
+ this(context, language, System.out);
+ }
+
public ScriptREPL(final Context context, final OutputStream out) {
- context.inject(this);
- this.out = out instanceof PrintStream ?
- (PrintStream) out : new PrintStream(out);
+ this(context, null, out);
}
- public ScriptREPL(final Context context, final String language) {
- this(context, language, System.out);
+ public ScriptREPL(final Context context, final String language,
+ final OutputStream out)
+ {
+ this(context, language, outputStreamConsumer(out));
}
- public ScriptREPL(final Context context, final String language, final OutputStream out) {
- this(context, out);
+ public ScriptREPL(final Context context, final String language,
+ final Consumer out)
+ {
+ context.inject(this);
languagePreference = language;
+ this.out = out;
}
/**
@@ -132,11 +142,39 @@ public void loop() throws IOException {
* @param in Input stream from which commands are read.
*/
public void loop(final InputStream in) throws IOException {
- initialize();
final BufferedReader bin = new BufferedReader(new InputStreamReader(in));
+ try {
+ loop(() -> {
+ try {
+ return bin.readLine();
+ }
+ catch (final IOException exc) {
+ throw new RuntimeException(exc);
+ }
+ });
+ }
+ catch (final RuntimeException exc) {
+ // NB: This convolution lets us throw IOException from inside a
+ // Supplier.get implementation, by wrapping in a RuntimeException.
+ // We then unwrap it again and throw it here, where we said we would.
+ final Throwable cause = exc.getCause();
+ if (cause instanceof IOException) throw (IOException) cause;
+ else throw exc;
+ }
+ }
+
+ /**
+ * Starts a Read-Eval-Print-Loop from the given source, returning when
+ * the loop terminates.
+ *
+ * @param in Source from which commands are read.
+ */
+ public void loop(final Supplier in) {
+ initialize();
while (true) {
prompt();
- final String line = bin.readLine();
+ final Object input = in.get();
+ final String line = input == null ? null : input.toString();
if (line == null) break;
if (!evaluate(line)) return;
}
@@ -157,54 +195,40 @@ public void initialize() {
*/
public void initialize(final boolean verbose) {
if (verbose) {
- out.println("Welcome to the SciJava REPL!");
- out.println();
+ println("Welcome to the SciJava REPL!");
+ println();
help();
}
final List langs = getInterpretedLanguages();
if (verbose) {
if (langs.isEmpty()) {
- out.println("--------------------------------------------------------------");
- out.println("Uh oh! There are no SciJava script languages available!");
- out.println("Are any on your classpath? E.g.: org.scijava:scripting-groovy?");
- out.println("--------------------------------------------------------------");
- out.println();
+ println("--------------------------------------------------------------");
+ println("Uh oh! There are no SciJava script languages available!");
+ println("Are any on your classpath? E.g.: org.scijava:scripting-groovy?");
+ println("--------------------------------------------------------------");
+ println();
return;
}
- out.println("Have fun!");
- out.println();
-
- if(languagePreference != null) {
- selectPreferredLanguage(langs);
- } else {
- lang(langs.get(0).getLanguageName());
- }
+ println("Have fun!");
+ println();
}
- else if (!langs.isEmpty()) {
- if(languagePreference != null) {
- selectPreferredLanguage(langs);
- } else {
- lang(langs.get(0));
- }
+ if (!langs.isEmpty()) {
+ if (languagePreference != null) selectPreferredLanguage(langs);
+ else lang(langs.get(0));
}
-
populateBindings(interpreter.getBindings());
}
private void selectPreferredLanguage(List langs) {
- final ScriptLanguage preference = langs
- .stream().filter(lang -> languagePreference.equals(lang.getLanguageName()))
- .findAny().orElse(null);
- if(preference != null) {
- lang(preference);
- } else {
- lang(langs.get(0).getLanguageName());
- }
+ final ScriptLanguage preference = langs.stream()
+ .filter(lang -> languagePreference.equals(lang.getLanguageName()))
+ .findFirst().orElse(langs.get(0));
+ lang(preference);
}
/** Outputs the prompt. */
public void prompt() {
- out.print(interpreter == null || interpreter.isReady() ? "> " : "\\ ");
+ print(interpreter == null || interpreter.isReady() ? "> " : "\\ ");
}
/**
@@ -230,22 +254,22 @@ public boolean evaluate(final String line) {
// pass the input to the current interpreter for evaluation
final Object result = interpreter.interpret(line);
if (result != ScriptInterpreter.MORE_INPUT_PENDING) {
- out.println(s(result));
+ println(s(result));
}
}
}
catch (final ScriptException exc) {
// NB: Something went wrong interpreting the line of code.
// Let's just display the error message, unless we are in debug mode.
- if (debug) exc.printStackTrace(out);
+ if (debug) printStackTrace(exc);
else {
final String msg = exc.getMessage();
- out.println(msg == null ? exc.getClass().getName() : msg);
+ println(msg == null ? exc.getClass().getName() : msg);
}
}
catch (final Throwable exc) {
// NB: Something unusual went wrong. Dump the whole exception always.
- exc.printStackTrace(out);
+ printStackTrace(exc);
}
return true;
}
@@ -254,17 +278,17 @@ public boolean evaluate(final String line) {
/** Prints a usage guide. */
public void help() {
- out.println("Available built-in commands:");
- out.println();
- out.println(" :help | this handy list of commands");
- out.println(" :vars | dump a list of variables");
- out.println(" :lang | switch the active language");
- out.println(" :langs | list available languages");
- out.println(" :debug | toggle full stack traces");
- out.println(" :quit | exit the REPL");
- out.println();
- out.println("Or type a statement to evaluate it with the active language.");
- out.println();
+ println("Available built-in commands:");
+ println();
+ println(" :help | this handy list of commands");
+ println(" :vars | dump a list of variables");
+ println(" :lang | switch the active language");
+ println(" :langs | list available languages");
+ println(" :debug | toggle full stack traces");
+ println(" :quit | exit the REPL");
+ println();
+ println("Or type a statement to evaluate it with the active language.");
+ println();
}
/** Lists variables in the script context. */
@@ -294,11 +318,11 @@ public void lang(final String langName) {
// create the new interpreter
final ScriptLanguage language = scriptService.getLanguageByName(langName);
if (language == null) {
- out.println("No such language: " + langName);
+ println("No such language: " + langName);
return;
}
lang(language);
- out.println("language -> " + interpreter.getLanguage().getLanguageName());
+ println("language -> " + interpreter.getLanguage().getLanguageName());
}
/**
@@ -316,7 +340,7 @@ public void lang(final ScriptLanguage language) {
copyBindings(interpreter, newInterpreter);
}
catch (final Throwable t) {
- t.printStackTrace(out);
+ printStackTrace(t);
}
interpreter = newInterpreter;
}
@@ -335,7 +359,7 @@ public void langs() {
public void debug() {
debug = !debug;
- out.println("debug mode -> " + debug);
+ println("debug mode -> " + debug);
}
// -- Main method --
@@ -417,7 +441,7 @@ private List gateways() {
gateways.add(gateway);
}
catch (final Throwable t) {
- t.printStackTrace(out);
+ printStackTrace(t);
}
}
return gateways;
@@ -442,6 +466,17 @@ private String type(final Object value) {
return "[" + decoded.getClass().getName() + "]";
}
+ private static final String NL = System.getProperty("line.separator");
+ private void print(String s) { out.accept(s); }
+ private void println() { print(NL); }
+ private void println(final String s) { print(s + NL); }
+
+ private void printStackTrace(final Throwable t) {
+ final ByteArrayOutputStream baos = new ByteArrayOutputStream();
+ t.printStackTrace(new PrintStream(baos));
+ println(baos.toString());
+ }
+
private void printColumns(final List... columns) {
final int pad = 2;
@@ -456,18 +491,28 @@ private void printColumns(final List... columns) {
}
// output the columns
+ final StringBuilder sb = new StringBuilder();
for (int i = 0; i < columns[0].size(); i++) {
+ sb.setLength(0);
for (int c = 0; c < columns.length; c++) {
final String s = s(columns[c].get(i));
- out.print(s);
- for (int p = s.length(); p < widths[c] + pad; p++) {
- out.print(' ');
+ sb.append(s);
+ if (c < columns.length - 1) {
+ for (int p = s.length(); p < widths[c] + pad; p++) {
+ sb.append(' ');
+ }
}
}
- out.println();
+ println(sb.toString());
}
}
+ private static Consumer outputStreamConsumer(final OutputStream out) {
+ final PrintStream ps = out instanceof PrintStream ?
+ (PrintStream) out : new PrintStream(out);
+ return s -> { ps.print(s); ps.flush(); };
+ }
+
private static String lowerCamelCase(final String s) {
final StringBuilder sb = new StringBuilder(s);
for (int i=0; i "script".equals(directive));
+ super("script"::equals);
}
@Parameter
@@ -106,6 +108,9 @@ public ScriptDirectiveScriptProcessor() {
@Parameter
private ModuleService moduleService;
+ @Parameter
+ private ScriptService scriptService;
+
// -- Internal DirectiveScriptProcessor methods --
@Override
@@ -125,6 +130,10 @@ private void assignAttribute(final String k, final Object v) {
if (is(k, "name")) info().setName(as(v, String.class));
else if (is(k, "label")) info().setLabel(as(v, String.class));
else if (is(k, "description")) info().setDescription(as(v, String.class));
+ else if (is(k, "language")) {
+ ScriptLanguage lang = parseScriptLanguage(v.toString());
+ if (lang != null) info().setLanguage(lang);
+ }
else if (is(k, "menuPath")) {
info().setMenuPath(new MenuPath(as(v, String.class)));
}
@@ -161,4 +170,12 @@ private Double priority(final Object p) {
if (lString.matches("last")) return Priority.LAST;
return null;
}
+
+ private ScriptLanguage parseScriptLanguage(final Object v) {
+ final String langHint = v.toString();
+ ScriptLanguage lang = scriptService.getLanguageByName(langHint);
+ if (lang == null) lang = scriptService.getLanguageByExtension(langHint);
+ if (lang == null) log.warn("Unknown script language: " + langHint);
+ return lang;
+ }
}
diff --git a/src/main/java/org/scijava/script/process/ScriptProcessor.java b/src/main/java/org/scijava/script/process/ScriptProcessor.java
index e4d86a36e..7e5347932 100644
--- a/src/main/java/org/scijava/script/process/ScriptProcessor.java
+++ b/src/main/java/org/scijava/script/process/ScriptProcessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/process/ScriptProcessorService.java b/src/main/java/org/scijava/script/process/ScriptProcessorService.java
index 458613b45..e78250b4d 100644
--- a/src/main/java/org/scijava/script/process/ScriptProcessorService.java
+++ b/src/main/java/org/scijava/script/process/ScriptProcessorService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/process/ShebangScriptProcessor.java b/src/main/java/org/scijava/script/process/ShebangScriptProcessor.java
index 5951b6dbb..188f50906 100644
--- a/src/main/java/org/scijava/script/process/ShebangScriptProcessor.java
+++ b/src/main/java/org/scijava/script/process/ShebangScriptProcessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/script/run/ScriptCodeRunner.java b/src/main/java/org/scijava/script/run/ScriptCodeRunner.java
index ac6535c89..86c73042b 100644
--- a/src/main/java/org/scijava/script/run/ScriptCodeRunner.java
+++ b/src/main/java/org/scijava/script/run/ScriptCodeRunner.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/service/AbstractService.java b/src/main/java/org/scijava/service/AbstractService.java
index 39062d6a8..d8f3ef1da 100644
--- a/src/main/java/org/scijava/service/AbstractService.java
+++ b/src/main/java/org/scijava/service/AbstractService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/service/SciJavaService.java b/src/main/java/org/scijava/service/SciJavaService.java
index afcad184a..d252e1b52 100644
--- a/src/main/java/org/scijava/service/SciJavaService.java
+++ b/src/main/java/org/scijava/service/SciJavaService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/service/Service.java b/src/main/java/org/scijava/service/Service.java
index c11d3c2a8..a7119ba21 100644
--- a/src/main/java/org/scijava/service/Service.java
+++ b/src/main/java/org/scijava/service/Service.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/service/ServiceHelper.java b/src/main/java/org/scijava/service/ServiceHelper.java
index 0e8db19d6..0cf2a21ed 100644
--- a/src/main/java/org/scijava/service/ServiceHelper.java
+++ b/src/main/java/org/scijava/service/ServiceHelper.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/service/ServiceIndex.java b/src/main/java/org/scijava/service/ServiceIndex.java
index 9632da00d..910c6273d 100644
--- a/src/main/java/org/scijava/service/ServiceIndex.java
+++ b/src/main/java/org/scijava/service/ServiceIndex.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/service/event/ServicesLoadedEvent.java b/src/main/java/org/scijava/service/event/ServicesLoadedEvent.java
index 0a9e58c27..e2fc6e3fe 100644
--- a/src/main/java/org/scijava/service/event/ServicesLoadedEvent.java
+++ b/src/main/java/org/scijava/service/event/ServicesLoadedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/startup/DefaultStartupService.java b/src/main/java/org/scijava/startup/DefaultStartupService.java
index 4104c3d19..d3b253a58 100644
--- a/src/main/java/org/scijava/startup/DefaultStartupService.java
+++ b/src/main/java/org/scijava/startup/DefaultStartupService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/startup/StartupService.java b/src/main/java/org/scijava/startup/StartupService.java
index 1dc08a2ee..6446b3447 100644
--- a/src/main/java/org/scijava/startup/StartupService.java
+++ b/src/main/java/org/scijava/startup/StartupService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/task/DefaultTask.java b/src/main/java/org/scijava/task/DefaultTask.java
index 44f1c3b30..310dd8f15 100644
--- a/src/main/java/org/scijava/task/DefaultTask.java
+++ b/src/main/java/org/scijava/task/DefaultTask.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -39,9 +39,9 @@
* Default implementation of {@link Task}. Throughout the task (or job),
* {@link Task#setProgressValue(long)} can be called to inform
* how the job is progressing.
- *
+ *
* Asynchronous case:
- * - A job (runnable) is sent for execution to the linked {@link ThreadService}.
+ * A job (runnable) is sent for execution to the linked {@link ThreadService}.
* It reports status updates via the linked {@link EventService}.
* A {@link org.scijava.task.event.TaskEvent} is sent before the job
* is started and when finished.
@@ -50,9 +50,10 @@
* by calling {@link Future#cancel(boolean)}.
* This default behaviour can be supplemented by an additional
* custom callback which can be set in {@link Task#setCancelCallBack(Runnable)}.
- *
+ *
+ *
* Synchronous case:
- * - A job that reports its status in between calls of {@link Task#start()},
+ * A job that reports its status in between calls of {@link Task#start()},
* and {@link Task#finish()}. It also reports its status via
* the linked {@link EventService}.
* Start and finish calls allow publishing proper {@link org.scijava.task.event.TaskEvent}
@@ -60,8 +61,10 @@
* Upon cancellation of a synchronous task, it is the responsibility
* of the synchronous task to handle its own cancellation through
* a custom callback which can be set via {@link Task#setCancelCallBack(Runnable)}.
+ *
*
- * @author Curtis Rueden, Nicolas Chiaruttini
+ * @author Curtis Rueden
+ * @author Nicolas Chiaruttini
*/
public class DefaultTask implements Task {
diff --git a/src/main/java/org/scijava/task/DefaultTaskService.java b/src/main/java/org/scijava/task/DefaultTaskService.java
index 09375262a..7a2016f51 100644
--- a/src/main/java/org/scijava/task/DefaultTaskService.java
+++ b/src/main/java/org/scijava/task/DefaultTaskService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/task/Task.java b/src/main/java/org/scijava/task/Task.java
index 7e6b66062..1dd539ab5 100644
--- a/src/main/java/org/scijava/task/Task.java
+++ b/src/main/java/org/scijava/task/Task.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/task/TaskService.java b/src/main/java/org/scijava/task/TaskService.java
index 887acf804..d3a46b7f9 100644
--- a/src/main/java/org/scijava/task/TaskService.java
+++ b/src/main/java/org/scijava/task/TaskService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/task/event/TaskEvent.java b/src/main/java/org/scijava/task/event/TaskEvent.java
index 79d55f7d2..bb4cfb4dd 100644
--- a/src/main/java/org/scijava/task/event/TaskEvent.java
+++ b/src/main/java/org/scijava/task/event/TaskEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/test/TestUtils.java b/src/main/java/org/scijava/test/TestUtils.java
index 7f9c63075..fd4ed17c7 100644
--- a/src/main/java/org/scijava/test/TestUtils.java
+++ b/src/main/java/org/scijava/test/TestUtils.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/text/AbstractTextFormat.java b/src/main/java/org/scijava/text/AbstractTextFormat.java
index 202092996..f07498edd 100644
--- a/src/main/java/org/scijava/text/AbstractTextFormat.java
+++ b/src/main/java/org/scijava/text/AbstractTextFormat.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -41,5 +41,14 @@
public abstract class AbstractTextFormat extends AbstractHandlerPlugin
implements TextFormat
{
- // NB: No implementation needed.
+ // -- Typed methods --
+
+ @Override
+ public boolean supports(final File data) {
+ // NB: This override is necessary, because the default super is
+ // AbstractHandlerPlugin->AbstractTypedPlugin->TypedPlugin->Typed,
+ // which fails to invoke the needed TextFormat.super.
+ // See fiji/fiji#303 and fiji/HDF5_Vibez#18.
+ return TextFormat.super.supports(data);
+ }
}
diff --git a/src/main/java/org/scijava/text/DefaultTextService.java b/src/main/java/org/scijava/text/DefaultTextService.java
index dab8a2898..9a562a334 100644
--- a/src/main/java/org/scijava/text/DefaultTextService.java
+++ b/src/main/java/org/scijava/text/DefaultTextService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -59,7 +59,7 @@ public final class DefaultTextService extends
@Override
public String open(final File file) throws IOException {
- // This routine is from: http://stackoverflow.com/a/326440
+ // This routine is from: https://stackoverflow.com/a/326440
try (final FileInputStream stream = new FileInputStream(file)) {
final FileChannel fc = stream.getChannel();
final MappedByteBuffer bb =
diff --git a/src/main/java/org/scijava/text/TextFormat.java b/src/main/java/org/scijava/text/TextFormat.java
index 40a314e8a..66f5fc405 100644
--- a/src/main/java/org/scijava/text/TextFormat.java
+++ b/src/main/java/org/scijava/text/TextFormat.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -63,6 +63,7 @@ public interface TextFormat extends HandlerPlugin {
@Override
default boolean supports(final File file) {
+ if (!HandlerPlugin.super.supports(file)) return false;
for (final String ext : getExtensions()) {
if (FileUtils.getExtension(file).equalsIgnoreCase(ext)) return true;
}
diff --git a/src/main/java/org/scijava/text/TextService.java b/src/main/java/org/scijava/text/TextService.java
index 8f640ba5f..6884d700f 100644
--- a/src/main/java/org/scijava/text/TextService.java
+++ b/src/main/java/org/scijava/text/TextService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/text/io/DefaultTextIOService.java b/src/main/java/org/scijava/text/io/DefaultTextIOService.java
index b1c9ad530..a16fc1933 100644
--- a/src/main/java/org/scijava/text/io/DefaultTextIOService.java
+++ b/src/main/java/org/scijava/text/io/DefaultTextIOService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/text/io/TextIOPlugin.java b/src/main/java/org/scijava/text/io/TextIOPlugin.java
index 04018a44f..cd4d4e5c4 100644
--- a/src/main/java/org/scijava/text/io/TextIOPlugin.java
+++ b/src/main/java/org/scijava/text/io/TextIOPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/text/io/TextIOService.java b/src/main/java/org/scijava/text/io/TextIOService.java
index 42e36e64a..d21d11c87 100644
--- a/src/main/java/org/scijava/text/io/TextIOService.java
+++ b/src/main/java/org/scijava/text/io/TextIOService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/thread/DefaultThreadService.java b/src/main/java/org/scijava/thread/DefaultThreadService.java
index 3262ee21d..121dc74e1 100644
--- a/src/main/java/org/scijava/thread/DefaultThreadService.java
+++ b/src/main/java/org/scijava/thread/DefaultThreadService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -39,6 +39,7 @@
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.ThreadFactory;
+import java.util.concurrent.TimeUnit;
import org.scijava.log.LogService;
import org.scijava.plugin.Parameter;
@@ -58,6 +59,8 @@ public final class DefaultThreadService extends AbstractService implements
private static final String SCIJAVA_THREAD_PREFIX = "SciJava-";
+ private static final long SHUTDOWN_TIMEOUT = 5000;
+
private static WeakHashMap parents =
new WeakHashMap<>();
@@ -159,11 +162,23 @@ public synchronized void dispose() {
disposed = true;
if (executor != null) {
executor.shutdown();
+ try {
+ executor.awaitTermination(SHUTDOWN_TIMEOUT, TimeUnit.MILLISECONDS);
+ }
+ catch (final InterruptedException exc) {
+ log.debug(exc);
+ }
executor = null;
}
if (queues != null) {
for (final ExecutorService queue : queues.values()) {
queue.shutdown();
+ try {
+ queue.awaitTermination(SHUTDOWN_TIMEOUT, TimeUnit.MILLISECONDS);
+ }
+ catch (final InterruptedException exc) {
+ log.debug(exc);
+ }
}
}
}
@@ -173,7 +188,14 @@ public synchronized void dispose() {
@Override
public Thread newThread(final Runnable r) {
final String threadName = contextThreadPrefix() + nextThread++;
- return new Thread(r, threadName);
+ final Thread thread = new Thread(r, threadName);
+ // NB: Use daemon threads for the thread pool, so that idling threads do
+ // not prevent the JVM shutdown sequence from starting. The application
+ // context, and therefore the thread service, will try to dispose itself
+ // upon JVM shutdown, which will invoke executor.awaitTermination(), so
+ // there will be a chance for these threads to complete any pending work.
+ thread.setDaemon(true);
+ return thread;
}
// -- Helper methods --
diff --git a/src/main/java/org/scijava/thread/ThreadService.java b/src/main/java/org/scijava/thread/ThreadService.java
index afddb6f8f..3531fc2a3 100644
--- a/src/main/java/org/scijava/thread/ThreadService.java
+++ b/src/main/java/org/scijava/thread/ThreadService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/tool/AbstractTool.java b/src/main/java/org/scijava/tool/AbstractTool.java
index 054fd1a8b..35f3d0d0d 100644
--- a/src/main/java/org/scijava/tool/AbstractTool.java
+++ b/src/main/java/org/scijava/tool/AbstractTool.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/tool/CustomDrawnTool.java b/src/main/java/org/scijava/tool/CustomDrawnTool.java
index 3a3905780..b7e766542 100644
--- a/src/main/java/org/scijava/tool/CustomDrawnTool.java
+++ b/src/main/java/org/scijava/tool/CustomDrawnTool.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/tool/DefaultToolService.java b/src/main/java/org/scijava/tool/DefaultToolService.java
index d78e1a53a..a8ae89fe7 100644
--- a/src/main/java/org/scijava/tool/DefaultToolService.java
+++ b/src/main/java/org/scijava/tool/DefaultToolService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/tool/DummyTool.java b/src/main/java/org/scijava/tool/DummyTool.java
index baef6dfe3..f8b90807e 100644
--- a/src/main/java/org/scijava/tool/DummyTool.java
+++ b/src/main/java/org/scijava/tool/DummyTool.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/tool/IconDrawer.java b/src/main/java/org/scijava/tool/IconDrawer.java
index 0d1b45824..1c4778eb1 100644
--- a/src/main/java/org/scijava/tool/IconDrawer.java
+++ b/src/main/java/org/scijava/tool/IconDrawer.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/tool/IconService.java b/src/main/java/org/scijava/tool/IconService.java
index 43ac9f66f..8c7473dcb 100644
--- a/src/main/java/org/scijava/tool/IconService.java
+++ b/src/main/java/org/scijava/tool/IconService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/tool/Tool.java b/src/main/java/org/scijava/tool/Tool.java
index cadfcf115..b42af857e 100644
--- a/src/main/java/org/scijava/tool/Tool.java
+++ b/src/main/java/org/scijava/tool/Tool.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/tool/ToolService.java b/src/main/java/org/scijava/tool/ToolService.java
index a254a91e3..061f3fed4 100644
--- a/src/main/java/org/scijava/tool/ToolService.java
+++ b/src/main/java/org/scijava/tool/ToolService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/tool/event/ToolActivatedEvent.java b/src/main/java/org/scijava/tool/event/ToolActivatedEvent.java
index 5142bbe18..3ab52fca2 100644
--- a/src/main/java/org/scijava/tool/event/ToolActivatedEvent.java
+++ b/src/main/java/org/scijava/tool/event/ToolActivatedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/tool/event/ToolDeactivatedEvent.java b/src/main/java/org/scijava/tool/event/ToolDeactivatedEvent.java
index 7503eed17..fc61e8332 100644
--- a/src/main/java/org/scijava/tool/event/ToolDeactivatedEvent.java
+++ b/src/main/java/org/scijava/tool/event/ToolDeactivatedEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/tool/event/ToolEvent.java b/src/main/java/org/scijava/tool/event/ToolEvent.java
index 6c6f1f185..f55392dc8 100644
--- a/src/main/java/org/scijava/tool/event/ToolEvent.java
+++ b/src/main/java/org/scijava/tool/event/ToolEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/ARGBPlane.java b/src/main/java/org/scijava/ui/ARGBPlane.java
index 5d7678f61..7d158e366 100644
--- a/src/main/java/org/scijava/ui/ARGBPlane.java
+++ b/src/main/java/org/scijava/ui/ARGBPlane.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/AbstractInputHarvesterPlugin.java b/src/main/java/org/scijava/ui/AbstractInputHarvesterPlugin.java
index 9d12ab82f..71afdf0cc 100644
--- a/src/main/java/org/scijava/ui/AbstractInputHarvesterPlugin.java
+++ b/src/main/java/org/scijava/ui/AbstractInputHarvesterPlugin.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/AbstractUIInputWidget.java b/src/main/java/org/scijava/ui/AbstractUIInputWidget.java
index 394ec8829..04561a123 100644
--- a/src/main/java/org/scijava/ui/AbstractUIInputWidget.java
+++ b/src/main/java/org/scijava/ui/AbstractUIInputWidget.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/AbstractUserInterface.java b/src/main/java/org/scijava/ui/AbstractUserInterface.java
index 0c3e22da5..8b5e426a5 100644
--- a/src/main/java/org/scijava/ui/AbstractUserInterface.java
+++ b/src/main/java/org/scijava/ui/AbstractUserInterface.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -79,6 +79,7 @@ public abstract class AbstractUserInterface extends AbstractRichPlugin
@Override
public void show() {
+ if (visible) return;
createUI();
visible = true;
}
diff --git a/src/main/java/org/scijava/ui/ApplicationFrame.java b/src/main/java/org/scijava/ui/ApplicationFrame.java
index dbda0cc80..571ab621e 100644
--- a/src/main/java/org/scijava/ui/ApplicationFrame.java
+++ b/src/main/java/org/scijava/ui/ApplicationFrame.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/Arrangeable.java b/src/main/java/org/scijava/ui/Arrangeable.java
index fb5a06dff..1b92b5768 100644
--- a/src/main/java/org/scijava/ui/Arrangeable.java
+++ b/src/main/java/org/scijava/ui/Arrangeable.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/CloseConfirmable.java b/src/main/java/org/scijava/ui/CloseConfirmable.java
index 56450088f..73e657b63 100644
--- a/src/main/java/org/scijava/ui/CloseConfirmable.java
+++ b/src/main/java/org/scijava/ui/CloseConfirmable.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/DefaultUIService.java b/src/main/java/org/scijava/ui/DefaultUIService.java
index 42899053b..7c8103a4c 100644
--- a/src/main/java/org/scijava/ui/DefaultUIService.java
+++ b/src/main/java/org/scijava/ui/DefaultUIService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -29,8 +29,10 @@
package org.scijava.ui;
+import java.awt.GraphicsEnvironment;
import java.io.File;
import java.io.FileFilter;
+import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
@@ -116,6 +118,9 @@ public final class DefaultUIService extends AbstractService implements
/** The default user interface to use, if one is not explicitly specified. */
private UserInterface defaultUI;
+ /** The last UI used when performing UI operations via the service. */
+ private UserInterface activeUI;
+
/**
* When true, {@link #isHeadless()} will return true regardless of the value
* of the {@code java.awt.headless} system property. When false, {@link
@@ -142,18 +147,12 @@ public void addUI(final String name, final UserInterface ui) {
@Override
public void showUI() {
if (disposed) return;
- final UserInterface ui = getDefaultUI();
- if (ui == null) {
- throw new IllegalStateException("No UIs available. " +
- "Please add a component containing a UIPlugin " +
- "(e.g., scijava-ui-swing) to your class-path.");
- }
- showUI(ui);
+ showUI(activeUI());
}
@Override
public void showUI(final String name) {
- final UserInterface ui = uiMap().get(name);
+ final UserInterface ui = getUI(name);
if (ui == null) {
throw new IllegalArgumentException("No such user interface: " + name);
}
@@ -163,24 +162,37 @@ public void showUI(final String name) {
@Override
public void showUI(final UserInterface ui) {
log.debug("Launching user interface: " + ui.getClass().getName());
- ui.show();
- // NB: Also show all the current displays.
- for (final Display display : displayService.getDisplays()) {
- ui.show(display);
+ Runnable showUI = () -> {
+ ui.show();
+ // NB: Also show all the current displays.
+ for (final Display display : displayService.getDisplays()) {
+ ui.show(display);
+ }
+ };
+
+ // Dispatch on EDT if necessary
+ if (ui.requiresEDT()) {
+ try {
+ threadService.invoke(showUI);
+ }
+ catch (InterruptedException | InvocationTargetException e) {
+ throw new RuntimeException(e);
+ }
+ }
+ else {
+ showUI.run();
}
eventService.publish(new UIShownEvent(ui));
}
@Override
public boolean isVisible() {
- final UserInterface ui = getDefaultUI();
- if (ui == null) return false;
- return ui.isVisible();
+ return activeUI().isVisible();
}
@Override
public boolean isVisible(final String name) {
- final UserInterface ui = uiMap().get(name);
+ final UserInterface ui = getUI(name);
return ui != null && ui.isVisible();
}
@@ -191,15 +203,15 @@ public void setHeadless(final boolean headless) {
@Override
public boolean isHeadless() {
- // NB: We do not use java.awt.GraphicsConfiguration.isHeadless()
- // because scijava-common eschews java.awt.* classes when possible.
- return forceHeadless || Boolean.getBoolean("java.awt.headless");
+ return forceHeadless ||
+ Boolean.getBoolean("java.awt.headless") ||
+ GraphicsEnvironment.isHeadless();
}
@Override
public UserInterface getDefaultUI() {
if (!initialized) discoverUIs();
- if (isHeadless()) return uiMap().get(HeadlessUI.NAME);
+ if (isHeadless()) return getUI(HeadlessUI.NAME);
if (defaultUI != null) return defaultUI;
return uiList().isEmpty() ? null : uiList().get(0);
}
@@ -243,17 +255,17 @@ public List>> getViewerPlugins() {
@Override
public void show(final Object o) {
- getDefaultUI().show(o);
+ activeUI().show(o);
}
@Override
public void show(final String name, final Object o) {
- getDefaultUI().show(name, o);
+ activeUI().show(name, o);
}
@Override
public void show(final Display display) {
- getDefaultUI().show(display);
+ activeUI().show(display);
}
@Override
@@ -308,45 +320,38 @@ public DialogPrompt.Result showDialog(final String message,
final String title, final DialogPrompt.MessageType messageType,
final DialogPrompt.OptionType optionType)
{
- final UserInterface ui = getDefaultUI();
- if (ui == null) return null;
- final DialogPrompt dialogPrompt =
- ui.dialogPrompt(message, title, messageType, optionType);
+ final DialogPrompt dialogPrompt = //
+ activeUI().dialogPrompt(message, title, messageType, optionType);
return dialogPrompt == null ? null : dialogPrompt.prompt();
}
@Override
public File chooseFile(final File file, final String style) {
- final UserInterface ui = getDefaultUI();
- return ui == null ? null : ui.chooseFile(file, style);
+ return activeUI().chooseFile(file, style);
}
@Override
public File
chooseFile(final String title, final File file, final String style)
{
- final UserInterface ui = getDefaultUI();
- return ui == null ? null : ui.chooseFile(title, file, style);
+ return activeUI().chooseFile(title, file, style);
}
@Override
public File[] chooseFiles(File parent, File[] files, FileFilter filter, String style) {
- final UserInterface ui = getDefaultUI();
- return ui == null ? null : ui.chooseFiles(parent, files, filter, style);
+ return activeUI().chooseFiles(parent, files, filter, style);
}
@Override
public List chooseFiles(File parent, List fileList, FileFilter filter, String style) {
- final UserInterface ui = getDefaultUI();
- return ui == null ? null : ui.chooseFiles(parent, fileList, filter, style);
+ return activeUI().chooseFiles(parent, fileList, filter, style);
}
@Override
public void showContextMenu(final String menuRoot, final Display display,
final int x, final int y)
{
- final UserInterface ui = getDefaultUI();
- if (ui != null) ui.showContextMenu(menuRoot, display, x, y);
+ activeUI().showContextMenu(menuRoot, display, x, y);
}
@Override
@@ -541,4 +546,17 @@ private void addUserInterface(final String name, final UserInterface ui) {
private String getTitle() {
return appService.getApp().getTitle();
}
+
+ /** Gets the UI to use when performing UI operations via the service. */
+ private UserInterface activeUI() {
+ // If a particular UI is already active and still visible, use that one.
+ if (activeUI != null && activeUI.isVisible()) return activeUI;
+
+ // If a UI is visible, use it.
+ final List visibleUIs = getVisibleUIs();
+ if (visibleUIs.size() > 0) return activeUI = visibleUIs.get(0);
+
+ // No UI is visible, so use the default one.
+ return activeUI = getDefaultUI();
+ }
}
diff --git a/src/main/java/org/scijava/ui/Desktop.java b/src/main/java/org/scijava/ui/Desktop.java
index bfca746d9..4e39f09dd 100644
--- a/src/main/java/org/scijava/ui/Desktop.java
+++ b/src/main/java/org/scijava/ui/Desktop.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/DialogPrompt.java b/src/main/java/org/scijava/ui/DialogPrompt.java
index 26c0ede95..0f598875a 100644
--- a/src/main/java/org/scijava/ui/DialogPrompt.java
+++ b/src/main/java/org/scijava/ui/DialogPrompt.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/FileListPreprocessor.java b/src/main/java/org/scijava/ui/FileListPreprocessor.java
index 13d8feb68..9d8da8f0b 100644
--- a/src/main/java/org/scijava/ui/FileListPreprocessor.java
+++ b/src/main/java/org/scijava/ui/FileListPreprocessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/FilePreprocessor.java b/src/main/java/org/scijava/ui/FilePreprocessor.java
index d03e43bc4..0e4a52d97 100644
--- a/src/main/java/org/scijava/ui/FilePreprocessor.java
+++ b/src/main/java/org/scijava/ui/FilePreprocessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/StatusBar.java b/src/main/java/org/scijava/ui/StatusBar.java
index 9b6b71377..009a5a7e0 100644
--- a/src/main/java/org/scijava/ui/StatusBar.java
+++ b/src/main/java/org/scijava/ui/StatusBar.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/SystemClipboard.java b/src/main/java/org/scijava/ui/SystemClipboard.java
index 8eb4e8bf6..a2f5b2c59 100644
--- a/src/main/java/org/scijava/ui/SystemClipboard.java
+++ b/src/main/java/org/scijava/ui/SystemClipboard.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/ToolBar.java b/src/main/java/org/scijava/ui/ToolBar.java
index 95a137aa5..289dbc8b4 100644
--- a/src/main/java/org/scijava/ui/ToolBar.java
+++ b/src/main/java/org/scijava/ui/ToolBar.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/UIPreprocessor.java b/src/main/java/org/scijava/ui/UIPreprocessor.java
index 87a755a14..d9af6ebca 100644
--- a/src/main/java/org/scijava/ui/UIPreprocessor.java
+++ b/src/main/java/org/scijava/ui/UIPreprocessor.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/UIService.java b/src/main/java/org/scijava/ui/UIService.java
index d3111bb3e..a86652b8e 100644
--- a/src/main/java/org/scijava/ui/UIService.java
+++ b/src/main/java/org/scijava/ui/UIService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -106,7 +106,7 @@ public interface UIService extends SciJavaService {
*
* Note that if the system itself is headless—which can be detected via
* the {@code java.awt.headless} system property or by calling
- * {@code java.awt.GraphicsEnvironment.isHeadless()}—then calling
+ * {@link java.awt.GraphicsEnvironment#isHeadless()}—then calling
* {@code setHeadless(false)} will have no effect; the system will still be
* headless, and {@link #isHeadless()} will still return true.
*
@@ -119,7 +119,15 @@ public interface UIService extends SciJavaService {
*/
void setHeadless(boolean isHeadless);
- /** Gets whether the UI is running in headless mode (no UI). */
+ /**
+ * Gets whether the UI is running in headless mode (no UI).
+ *
+ * More precisely: returns true when {@code java.awt.headless} system
+ * property is set, and/or {@link java.awt.GraphicsEnvironment#isHeadless()}
+ * returns true, and/or {@link #setHeadless(boolean)} was called with {@code
+ * true} to force headless behavior in an otherwise headful environment.
+ *
+ */
boolean isHeadless();
/**
diff --git a/src/main/java/org/scijava/ui/UserInterface.java b/src/main/java/org/scijava/ui/UserInterface.java
index 162532dac..c2808bdc1 100644
--- a/src/main/java/org/scijava/ui/UserInterface.java
+++ b/src/main/java/org/scijava/ui/UserInterface.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -41,6 +41,7 @@
import org.scijava.ui.console.ConsolePane;
import org.scijava.ui.viewer.DisplayWindow;
import org.scijava.widget.FileWidget;
+import org.scijava.widget.WidgetStyle;
/**
* An end-user SciJava application user interface.
@@ -160,11 +161,11 @@ DialogPrompt dialogPrompt(String message, String title,
default File chooseFile(final File file, final String style) {
final String title;
// style can be a string with multiple comma-separated keywords
- // TODO use a utility class for style handling, e.g. StyleUtils.isStyle(style, ...)
if (style == null) title = "Choose a file";
- else if (style.toLowerCase().contains(FileWidget.DIRECTORY_STYLE)) title = "Choose a directory";
- else if (style.toLowerCase().contains(FileWidget.OPEN_STYLE)) title = "Open";
- else if (style.toLowerCase().contains(FileWidget.SAVE_STYLE)) title = "Save";
+ else if (WidgetStyle.isStyle(style, FileWidget.DIRECTORY_STYLE)) title = "Choose a directory";
+ else if (WidgetStyle.isStyle(style, FileWidget.FILE_AND_DIRECTORY_STYLE)) title = "Choose a file or directory";
+ else if (WidgetStyle.isStyle(style, FileWidget.OPEN_STYLE)) title = "Open";
+ else if (WidgetStyle.isStyle(style, FileWidget.SAVE_STYLE)) title = "Save";
else title = "Choose a file";
return chooseFile(title, file, style);
@@ -180,6 +181,7 @@ default File chooseFile(final File file, final String style) {
* {@link FileWidget#OPEN_STYLE}
* {@link FileWidget#SAVE_STYLE}
* {@link FileWidget#DIRECTORY_STYLE}
+ * {@link FileWidget#FILE_AND_DIRECTORY_STYLE}
*
* @return The {@link File} chosen by the user, or null if prompt is not
* available
diff --git a/src/main/java/org/scijava/ui/console/AbstractConsolePane.java b/src/main/java/org/scijava/ui/console/AbstractConsolePane.java
index db4817ceb..1657a42e4 100644
--- a/src/main/java/org/scijava/ui/console/AbstractConsolePane.java
+++ b/src/main/java/org/scijava/ui/console/AbstractConsolePane.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/console/ConsolePane.java b/src/main/java/org/scijava/ui/console/ConsolePane.java
index 7145ed54a..de3c876b0 100644
--- a/src/main/java/org/scijava/ui/console/ConsolePane.java
+++ b/src/main/java/org/scijava/ui/console/ConsolePane.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/console/HeadlessArgument.java b/src/main/java/org/scijava/ui/console/HeadlessArgument.java
index 3a10f459d..821dd516e 100644
--- a/src/main/java/org/scijava/ui/console/HeadlessArgument.java
+++ b/src/main/java/org/scijava/ui/console/HeadlessArgument.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/console/ShowUIArgument.java b/src/main/java/org/scijava/ui/console/ShowUIArgument.java
index 9d0c1161b..00b7a192f 100644
--- a/src/main/java/org/scijava/ui/console/ShowUIArgument.java
+++ b/src/main/java/org/scijava/ui/console/ShowUIArgument.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/console/UIArgument.java b/src/main/java/org/scijava/ui/console/UIArgument.java
index 0deeba42b..8f962fbe7 100644
--- a/src/main/java/org/scijava/ui/console/UIArgument.java
+++ b/src/main/java/org/scijava/ui/console/UIArgument.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/dnd/AbstractDragAndDropData.java b/src/main/java/org/scijava/ui/dnd/AbstractDragAndDropData.java
index 09e3efb79..0e9d59514 100644
--- a/src/main/java/org/scijava/ui/dnd/AbstractDragAndDropData.java
+++ b/src/main/java/org/scijava/ui/dnd/AbstractDragAndDropData.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/dnd/AbstractDragAndDropHandler.java b/src/main/java/org/scijava/ui/dnd/AbstractDragAndDropHandler.java
index 05d350bd7..77bf71ca0 100644
--- a/src/main/java/org/scijava/ui/dnd/AbstractDragAndDropHandler.java
+++ b/src/main/java/org/scijava/ui/dnd/AbstractDragAndDropHandler.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/dnd/DefaultDragAndDropData.java b/src/main/java/org/scijava/ui/dnd/DefaultDragAndDropData.java
index 0529ea7c5..e6095d0ea 100644
--- a/src/main/java/org/scijava/ui/dnd/DefaultDragAndDropData.java
+++ b/src/main/java/org/scijava/ui/dnd/DefaultDragAndDropData.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/dnd/DefaultDragAndDropService.java b/src/main/java/org/scijava/ui/dnd/DefaultDragAndDropService.java
index 524f5a887..4b36ad97d 100644
--- a/src/main/java/org/scijava/ui/dnd/DefaultDragAndDropService.java
+++ b/src/main/java/org/scijava/ui/dnd/DefaultDragAndDropService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/dnd/DragAndDropData.java b/src/main/java/org/scijava/ui/dnd/DragAndDropData.java
index d5924bbbc..2d3c6f856 100644
--- a/src/main/java/org/scijava/ui/dnd/DragAndDropData.java
+++ b/src/main/java/org/scijava/ui/dnd/DragAndDropData.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/dnd/DragAndDropHandler.java b/src/main/java/org/scijava/ui/dnd/DragAndDropHandler.java
index 4f7d47043..419ef09e6 100644
--- a/src/main/java/org/scijava/ui/dnd/DragAndDropHandler.java
+++ b/src/main/java/org/scijava/ui/dnd/DragAndDropHandler.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/dnd/DragAndDropService.java b/src/main/java/org/scijava/ui/dnd/DragAndDropService.java
index a7b394407..d63c06e53 100644
--- a/src/main/java/org/scijava/ui/dnd/DragAndDropService.java
+++ b/src/main/java/org/scijava/ui/dnd/DragAndDropService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/dnd/FileDragAndDropHandler.java b/src/main/java/org/scijava/ui/dnd/FileDragAndDropHandler.java
index 11aa98108..4e16054f7 100644
--- a/src/main/java/org/scijava/ui/dnd/FileDragAndDropHandler.java
+++ b/src/main/java/org/scijava/ui/dnd/FileDragAndDropHandler.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/dnd/ListDragAndDropHandler.java b/src/main/java/org/scijava/ui/dnd/ListDragAndDropHandler.java
index 9ca0833ca..0057d863e 100644
--- a/src/main/java/org/scijava/ui/dnd/ListDragAndDropHandler.java
+++ b/src/main/java/org/scijava/ui/dnd/ListDragAndDropHandler.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/dnd/MIMEType.java b/src/main/java/org/scijava/ui/dnd/MIMEType.java
index c5fd7ec61..71e1f13f1 100644
--- a/src/main/java/org/scijava/ui/dnd/MIMEType.java
+++ b/src/main/java/org/scijava/ui/dnd/MIMEType.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/dnd/ScriptFileDragAndDropHandler.java b/src/main/java/org/scijava/ui/dnd/ScriptFileDragAndDropHandler.java
index a798ff7ec..f456671ae 100644
--- a/src/main/java/org/scijava/ui/dnd/ScriptFileDragAndDropHandler.java
+++ b/src/main/java/org/scijava/ui/dnd/ScriptFileDragAndDropHandler.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/dnd/event/DragAndDropEvent.java b/src/main/java/org/scijava/ui/dnd/event/DragAndDropEvent.java
index 20c240ead..4aecd6b8b 100644
--- a/src/main/java/org/scijava/ui/dnd/event/DragAndDropEvent.java
+++ b/src/main/java/org/scijava/ui/dnd/event/DragAndDropEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/dnd/event/DragEnterEvent.java b/src/main/java/org/scijava/ui/dnd/event/DragEnterEvent.java
index f219555ab..7b09815ba 100644
--- a/src/main/java/org/scijava/ui/dnd/event/DragEnterEvent.java
+++ b/src/main/java/org/scijava/ui/dnd/event/DragEnterEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/dnd/event/DragExitEvent.java b/src/main/java/org/scijava/ui/dnd/event/DragExitEvent.java
index fbe9b6ce1..5f07f0b9d 100644
--- a/src/main/java/org/scijava/ui/dnd/event/DragExitEvent.java
+++ b/src/main/java/org/scijava/ui/dnd/event/DragExitEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/dnd/event/DragOverEvent.java b/src/main/java/org/scijava/ui/dnd/event/DragOverEvent.java
index f0376b017..7baeaa77e 100644
--- a/src/main/java/org/scijava/ui/dnd/event/DragOverEvent.java
+++ b/src/main/java/org/scijava/ui/dnd/event/DragOverEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/dnd/event/DropEvent.java b/src/main/java/org/scijava/ui/dnd/event/DropEvent.java
index 0fd7677e6..2775e56f0 100644
--- a/src/main/java/org/scijava/ui/dnd/event/DropEvent.java
+++ b/src/main/java/org/scijava/ui/dnd/event/DropEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/event/UIEvent.java b/src/main/java/org/scijava/ui/event/UIEvent.java
index 0f4e3a9b0..84a32ed63 100644
--- a/src/main/java/org/scijava/ui/event/UIEvent.java
+++ b/src/main/java/org/scijava/ui/event/UIEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/event/UIShownEvent.java b/src/main/java/org/scijava/ui/event/UIShownEvent.java
index d7b893f3c..2de7f2685 100644
--- a/src/main/java/org/scijava/ui/event/UIShownEvent.java
+++ b/src/main/java/org/scijava/ui/event/UIShownEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/headless/HeadlessDisplayViewer.java b/src/main/java/org/scijava/ui/headless/HeadlessDisplayViewer.java
index 3352913e3..dc65aae76 100644
--- a/src/main/java/org/scijava/ui/headless/HeadlessDisplayViewer.java
+++ b/src/main/java/org/scijava/ui/headless/HeadlessDisplayViewer.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/headless/HeadlessUI.java b/src/main/java/org/scijava/ui/headless/HeadlessUI.java
index c8aceb5ae..04536a6c0 100644
--- a/src/main/java/org/scijava/ui/headless/HeadlessUI.java
+++ b/src/main/java/org/scijava/ui/headless/HeadlessUI.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/headlessUI/HeadlessUI.java b/src/main/java/org/scijava/ui/headlessUI/HeadlessUI.java
index 96f51ff72..d473685b3 100644
--- a/src/main/java/org/scijava/ui/headlessUI/HeadlessUI.java
+++ b/src/main/java/org/scijava/ui/headlessUI/HeadlessUI.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/viewer/AbstractDisplayViewer.java b/src/main/java/org/scijava/ui/viewer/AbstractDisplayViewer.java
index 35cefdadc..418f43830 100644
--- a/src/main/java/org/scijava/ui/viewer/AbstractDisplayViewer.java
+++ b/src/main/java/org/scijava/ui/viewer/AbstractDisplayViewer.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/viewer/DisplayPanel.java b/src/main/java/org/scijava/ui/viewer/DisplayPanel.java
index f438822c0..3f88949e4 100644
--- a/src/main/java/org/scijava/ui/viewer/DisplayPanel.java
+++ b/src/main/java/org/scijava/ui/viewer/DisplayPanel.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/viewer/DisplayViewer.java b/src/main/java/org/scijava/ui/viewer/DisplayViewer.java
index 657e860b5..9698cb56e 100644
--- a/src/main/java/org/scijava/ui/viewer/DisplayViewer.java
+++ b/src/main/java/org/scijava/ui/viewer/DisplayViewer.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/viewer/DisplayWindow.java b/src/main/java/org/scijava/ui/viewer/DisplayWindow.java
index d9d4945c4..c6397ed6e 100644
--- a/src/main/java/org/scijava/ui/viewer/DisplayWindow.java
+++ b/src/main/java/org/scijava/ui/viewer/DisplayWindow.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/viewer/text/AbstractTextDisplayViewer.java b/src/main/java/org/scijava/ui/viewer/text/AbstractTextDisplayViewer.java
index 2b6e93004..e19a33e18 100644
--- a/src/main/java/org/scijava/ui/viewer/text/AbstractTextDisplayViewer.java
+++ b/src/main/java/org/scijava/ui/viewer/text/AbstractTextDisplayViewer.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/viewer/text/TextDisplayPanel.java b/src/main/java/org/scijava/ui/viewer/text/TextDisplayPanel.java
index 3f0ba3fec..107d46aa8 100644
--- a/src/main/java/org/scijava/ui/viewer/text/TextDisplayPanel.java
+++ b/src/main/java/org/scijava/ui/viewer/text/TextDisplayPanel.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/ui/viewer/text/TextDisplayViewer.java b/src/main/java/org/scijava/ui/viewer/text/TextDisplayViewer.java
index 302a6f41a..4efb2adb1 100644
--- a/src/main/java/org/scijava/ui/viewer/text/TextDisplayViewer.java
+++ b/src/main/java/org/scijava/ui/viewer/text/TextDisplayViewer.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/AbstractPrimitiveArray.java b/src/main/java/org/scijava/util/AbstractPrimitiveArray.java
index 735f286b0..6b284c0c3 100644
--- a/src/main/java/org/scijava/util/AbstractPrimitiveArray.java
+++ b/src/main/java/org/scijava/util/AbstractPrimitiveArray.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/AppUtils.java b/src/main/java/org/scijava/util/AppUtils.java
index e83e06798..134aa2ac4 100644
--- a/src/main/java/org/scijava/util/AppUtils.java
+++ b/src/main/java/org/scijava/util/AppUtils.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -130,7 +130,7 @@ public static File getBaseDirectory(final Class c) {
public static File getBaseDirectory(final Class c,
final String baseSubdirectory)
{
- // see: http://stackoverflow.com/a/12733172/1207769
+ // see: https://stackoverflow.com/a/12733172/1207769
// step 1: convert Class to URL
final URL location = Types.location(c);
@@ -171,7 +171,7 @@ public static File getBaseDirectory(final Class c,
* this cache is located in {@code ~/.m2/repository}. The location will be
* {@code groupId/artifactId/version/artifactId-version.jar} where
* {@code groupId}, {@code artifactId} and {@code version} are the Maven GAV
+ * href="https://maven.apache.org/pom.html#Maven_Coordinates">Maven GAV
* coordinates . Note that in this case, no base directory with respect to
* the given class can be found, and this method will return null.
* Within a JAR file beneath the base directory. Common cases
diff --git a/src/main/java/org/scijava/util/ArrayUtils.java b/src/main/java/org/scijava/util/ArrayUtils.java
index c6487c5cf..42afdfbcb 100644
--- a/src/main/java/org/scijava/util/ArrayUtils.java
+++ b/src/main/java/org/scijava/util/ArrayUtils.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -88,7 +88,7 @@ public static T[] array(final T... values) {
* object is an array type, a {@link PrimitiveArray} wrapper will be created.
*/
public static Collection toCollection(final Object value) {
- // If the value is null or we we have a collection, just return it
+ // If the value is null or we have a collection, just return it
if (value == null || Collection.class.isAssignableFrom(value.getClass())) {
return (Collection) value;
}
diff --git a/src/main/java/org/scijava/util/BoolArray.java b/src/main/java/org/scijava/util/BoolArray.java
index 72e192bbe..d0d6589b7 100644
--- a/src/main/java/org/scijava/util/BoolArray.java
+++ b/src/main/java/org/scijava/util/BoolArray.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/ByteArray.java b/src/main/java/org/scijava/util/ByteArray.java
index f1e831c0e..ad092abb5 100644
--- a/src/main/java/org/scijava/util/ByteArray.java
+++ b/src/main/java/org/scijava/util/ByteArray.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/Bytes.java b/src/main/java/org/scijava/util/Bytes.java
index fbce5e167..5b56f8d03 100644
--- a/src/main/java/org/scijava/util/Bytes.java
+++ b/src/main/java/org/scijava/util/Bytes.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/CharArray.java b/src/main/java/org/scijava/util/CharArray.java
index bfe0ae73e..8459597da 100644
--- a/src/main/java/org/scijava/util/CharArray.java
+++ b/src/main/java/org/scijava/util/CharArray.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/CheckSezpoz.java b/src/main/java/org/scijava/util/CheckSezpoz.java
index 459260f05..d5f384f9e 100644
--- a/src/main/java/org/scijava/util/CheckSezpoz.java
+++ b/src/main/java/org/scijava/util/CheckSezpoz.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/ClassUtils.java b/src/main/java/org/scijava/util/ClassUtils.java
index d9d3b2f67..e9e7e4dc0 100644
--- a/src/main/java/org/scijava/util/ClassUtils.java
+++ b/src/main/java/org/scijava/util/ClassUtils.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/ColorRGB.java b/src/main/java/org/scijava/util/ColorRGB.java
index 129eaf5f4..5cbcfb181 100644
--- a/src/main/java/org/scijava/util/ColorRGB.java
+++ b/src/main/java/org/scijava/util/ColorRGB.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/ColorRGBA.java b/src/main/java/org/scijava/util/ColorRGBA.java
index b7c55622b..34f2dac25 100644
--- a/src/main/java/org/scijava/util/ColorRGBA.java
+++ b/src/main/java/org/scijava/util/ColorRGBA.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/Colors.java b/src/main/java/org/scijava/util/Colors.java
index f32b4fad9..fcc65027b 100644
--- a/src/main/java/org/scijava/util/Colors.java
+++ b/src/main/java/org/scijava/util/Colors.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/CombineAnnotations.java b/src/main/java/org/scijava/util/CombineAnnotations.java
index 002659f4a..b248d64b3 100644
--- a/src/main/java/org/scijava/util/CombineAnnotations.java
+++ b/src/main/java/org/scijava/util/CombineAnnotations.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/Combiner.java b/src/main/java/org/scijava/util/Combiner.java
index e4babbe96..209c57c08 100644
--- a/src/main/java/org/scijava/util/Combiner.java
+++ b/src/main/java/org/scijava/util/Combiner.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/ConversionUtils.java b/src/main/java/org/scijava/util/ConversionUtils.java
index 99b30254c..e1dd17570 100644
--- a/src/main/java/org/scijava/util/ConversionUtils.java
+++ b/src/main/java/org/scijava/util/ConversionUtils.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -30,22 +30,66 @@
package org.scijava.util;
import java.lang.reflect.Type;
+import java.util.Arrays;
+import java.util.List;
import org.scijava.convert.ConversionRequest;
import org.scijava.convert.ConvertService;
import org.scijava.convert.Converter;
-import org.scijava.convert.DefaultConverter;
-import org.scijava.util.Types;
/** @deprecated use {@link ConvertService} and {@link Types} */
@Deprecated
public class ConversionUtils {
- private static ConvertService convertService;
-
- private static Converter converterNoContext;
-
- private static double servicePriority = 0.0;
+ private static List> converters = Arrays.asList(
+ new org.scijava.convert.NullConverter(),
+ new org.scijava.convert.CastingConverter(),
+ new org.scijava.convert.ArrayConverters.BoolArrayUnwrapper(),
+ new org.scijava.convert.ArrayConverters.BoolArrayWrapper(),
+ new org.scijava.convert.ArrayConverters.ByteArrayUnwrapper(),
+ new org.scijava.convert.ArrayConverters.ByteArrayWrapper(),
+ new org.scijava.convert.ArrayConverters.CharArrayUnwrapper(),
+ new org.scijava.convert.ArrayConverters.CharArrayWrapper(),
+ new org.scijava.convert.ArrayConverters.DoubleArrayUnwrapper(),
+ new org.scijava.convert.ArrayConverters.DoubleArrayWrapper(),
+ new org.scijava.convert.ArrayConverters.FloatArrayUnwrapper(),
+ new org.scijava.convert.ArrayConverters.FloatArrayWrapper(),
+ new org.scijava.convert.ArrayConverters.IntArrayUnwrapper(),
+ new org.scijava.convert.ArrayConverters.IntArrayWrapper(),
+ new org.scijava.convert.ArrayConverters.LongArrayUnwrapper(),
+ new org.scijava.convert.ArrayConverters.LongArrayWrapper(),
+ new org.scijava.convert.ArrayConverters.ShortArrayUnwrapper(),
+ new org.scijava.convert.ArrayConverters.ShortArrayWrapper(),
+ new org.scijava.convert.FileListConverters.FileArrayToStringConverter(),
+ new org.scijava.convert.FileListConverters.FileToStringConverter(),
+ new org.scijava.convert.FileListConverters.StringToFileArrayConverter(),
+ new org.scijava.convert.FileListConverters.StringToFileConverter(),
+ new org.scijava.convert.NumberConverters.BigIntegerToBigDecimalConverter(),
+ new org.scijava.convert.NumberConverters.ByteToBigDecimalConverter(),
+ new org.scijava.convert.NumberConverters.ByteToBigIntegerConverter(),
+ new org.scijava.convert.NumberConverters.ByteToDoubleConverter(),
+ new org.scijava.convert.NumberConverters.ByteToFloatConverter(),
+ new org.scijava.convert.NumberConverters.ByteToIntegerConverter(),
+ new org.scijava.convert.NumberConverters.ByteToLongConverter(),
+ new org.scijava.convert.NumberConverters.ByteToShortConverter(),
+ new org.scijava.convert.NumberConverters.DoubleToBigDecimalConverter(),
+ new org.scijava.convert.NumberConverters.FloatToBigDecimalConverter(),
+ new org.scijava.convert.NumberConverters.FloatToDoubleConverter(),
+ new org.scijava.convert.NumberConverters.IntegerToBigDecimalConverter(),
+ new org.scijava.convert.NumberConverters.IntegerToBigIntegerConverter(),
+ new org.scijava.convert.NumberConverters.IntegerToDoubleConverter(),
+ new org.scijava.convert.NumberConverters.IntegerToLongConverter(),
+ new org.scijava.convert.NumberConverters.LongToBigDecimalConverter(),
+ new org.scijava.convert.NumberConverters.LongToBigIntegerConverter(),
+ new org.scijava.convert.NumberConverters.ShortToBigDecimalConverter(),
+ new org.scijava.convert.NumberConverters.ShortToBigIntegerConverter(),
+ new org.scijava.convert.NumberConverters.ShortToDoubleConverter(),
+ new org.scijava.convert.NumberConverters.ShortToFloatConverter(),
+ new org.scijava.convert.NumberConverters.ShortToIntegerConverter(),
+ new org.scijava.convert.NumberConverters.ShortToLongConverter(),
+ new org.scijava.convert.StringToNumberConverter(),
+ new org.scijava.convert.DefaultConverter()
+ );
private ConversionUtils() {
// prevent instantiation of utility class
@@ -53,18 +97,13 @@ private ConversionUtils() {
// -- ConvertService setter --
- /**
- * Sets the {@link ConvertService} to use for handling conversion requests.
- */
+ /** @deprecated This method should not be used anymore. */
+ @Deprecated
+ @SuppressWarnings("unused")
public static void setDelegateService(final ConvertService convertService,
final double priority)
{
- if (ConversionUtils.convertService == null || Double.compare(priority,
- servicePriority) > 0)
- {
- ConversionUtils.convertService = convertService;
- servicePriority = priority;
- }
+ // NB: This method is now a no-op.
}
// -- Deprecated methods --
@@ -209,17 +248,11 @@ public static T getNullValue(final Class type) {
// -- Helper methods --
/**
- * Gets the {@link Converter} to use for the given conversion request. If the
- * delegate {@link ConvertService} has not been explicitly set, then a
- * {@link DefaultConverter} will be used.
+ * Gets the {@link Converter} to use for the given conversion request.
*
* @return The {@link Converter} to use for handling the given request.
*/
private static Converter handler(final ConversionRequest data) {
- if (convertService != null) return convertService.getHandler(data);
-
- if (converterNoContext == null) converterNoContext = new DefaultConverter();
-
- return converterNoContext;
+ return converters.stream().filter(c -> c.supports(data)).findFirst().orElse(null);
}
}
diff --git a/src/main/java/org/scijava/util/DebugUtils.java b/src/main/java/org/scijava/util/DebugUtils.java
index 4e88f180b..44e28f780 100644
--- a/src/main/java/org/scijava/util/DebugUtils.java
+++ b/src/main/java/org/scijava/util/DebugUtils.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/DefaultTreeNode.java b/src/main/java/org/scijava/util/DefaultTreeNode.java
index db60c7673..e2c97985d 100644
--- a/src/main/java/org/scijava/util/DefaultTreeNode.java
+++ b/src/main/java/org/scijava/util/DefaultTreeNode.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/DigestUtils.java b/src/main/java/org/scijava/util/DigestUtils.java
index b78af02ae..84a79eb66 100644
--- a/src/main/java/org/scijava/util/DigestUtils.java
+++ b/src/main/java/org/scijava/util/DigestUtils.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -32,8 +32,7 @@
import java.io.UnsupportedEncodingException;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
-
-import javax.xml.bind.DatatypeConverter;
+import java.util.Base64;
/**
* Utility class for computing cryptographic hashes.
@@ -98,7 +97,7 @@ public static String hex(final byte[] bytes) {
/** Converts the given byte array to a base64 string. */
public static String base64(final byte[] bytes) {
- return DatatypeConverter.printBase64Binary(bytes);
+ return new String(Base64.getEncoder().encode(bytes));
}
/**
diff --git a/src/main/java/org/scijava/util/DoubleArray.java b/src/main/java/org/scijava/util/DoubleArray.java
index 928d62af6..de007478c 100644
--- a/src/main/java/org/scijava/util/DoubleArray.java
+++ b/src/main/java/org/scijava/util/DoubleArray.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/FileUtils.java b/src/main/java/org/scijava/util/FileUtils.java
index 4de14f37f..2761edf73 100644
--- a/src/main/java/org/scijava/util/FileUtils.java
+++ b/src/main/java/org/scijava/util/FileUtils.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -28,7 +28,7 @@
*/
// File path shortening code adapted from:
-// from: http://www.rgagnon.com/javadetails/java-0661.html
+// from: https://www.rgagnon.com/javadetails/java-0661.html
package org.scijava.util;
@@ -729,8 +729,9 @@ private static String classifiers() {
"sources",
"javadoc",
"natives?-?\\w*",
- "(natives-)?(android|linux|macosx|solaris|windows)-" +
- "(aarch64|amd64|arm|armv6|armv6hf|i586|universal|x86|x86_64)",
+ "(natives-)?(android|linux|macosx|macos|solaris|windows)-" +
+ "(aarch64|amd64|arm64|armv6hf|armv6|arm|" +
+ "i386|i486|i586|i686|universal|x86[_-]32|x86[_-]64|x86)",
};
final StringBuilder sb = new StringBuilder("(");
for (final String classifier : classifiers) {
diff --git a/src/main/java/org/scijava/util/FloatArray.java b/src/main/java/org/scijava/util/FloatArray.java
index f232814d6..49046497a 100644
--- a/src/main/java/org/scijava/util/FloatArray.java
+++ b/src/main/java/org/scijava/util/FloatArray.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/GenericUtils.java b/src/main/java/org/scijava/util/GenericUtils.java
index fd5d3e9a7..9cdb71614 100644
--- a/src/main/java/org/scijava/util/GenericUtils.java
+++ b/src/main/java/org/scijava/util/GenericUtils.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/IntArray.java b/src/main/java/org/scijava/util/IntArray.java
index 6d0086a17..f3c6a8e71 100644
--- a/src/main/java/org/scijava/util/IntArray.java
+++ b/src/main/java/org/scijava/util/IntArray.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/IntCoords.java b/src/main/java/org/scijava/util/IntCoords.java
index 80d18eafc..d0498a7f3 100644
--- a/src/main/java/org/scijava/util/IntCoords.java
+++ b/src/main/java/org/scijava/util/IntCoords.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/IntRect.java b/src/main/java/org/scijava/util/IntRect.java
index 508fc5eeb..33670744f 100644
--- a/src/main/java/org/scijava/util/IntRect.java
+++ b/src/main/java/org/scijava/util/IntRect.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/IteratorPlus.java b/src/main/java/org/scijava/util/IteratorPlus.java
index 990246fd9..35c9cd3b6 100644
--- a/src/main/java/org/scijava/util/IteratorPlus.java
+++ b/src/main/java/org/scijava/util/IteratorPlus.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/LastRecentlyUsed.java b/src/main/java/org/scijava/util/LastRecentlyUsed.java
index 84ea1ecb8..50d292856 100644
--- a/src/main/java/org/scijava/util/LastRecentlyUsed.java
+++ b/src/main/java/org/scijava/util/LastRecentlyUsed.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -143,7 +143,7 @@ public boolean replace(final int index, T newValue) {
throw new IllegalArgumentException("No current entry at position " +
index);
}
- if (newValue.equals(previous)) return false;
+ if (newValue.equals(previousValue)) return false;
map.remove(previousValue);
map.put(newValue, index);
entries[index] = newValue;
diff --git a/src/main/java/org/scijava/util/LineOutputStream.java b/src/main/java/org/scijava/util/LineOutputStream.java
index 38b014a14..b0cd47e87 100644
--- a/src/main/java/org/scijava/util/LineOutputStream.java
+++ b/src/main/java/org/scijava/util/LineOutputStream.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/ListUtils.java b/src/main/java/org/scijava/util/ListUtils.java
index 170124839..8f07d06a3 100644
--- a/src/main/java/org/scijava/util/ListUtils.java
+++ b/src/main/java/org/scijava/util/ListUtils.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -28,7 +28,7 @@
*/
// File path shortening code adapted from:
-// from: http://www.rgagnon.com/javadetails/java-0661.html
+// from: https://www.rgagnon.com/javadetails/java-0661.html
package org.scijava.util;
diff --git a/src/main/java/org/scijava/util/LongArray.java b/src/main/java/org/scijava/util/LongArray.java
index 61ffed4a9..12ae4a737 100644
--- a/src/main/java/org/scijava/util/LongArray.java
+++ b/src/main/java/org/scijava/util/LongArray.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/Manifest.java b/src/main/java/org/scijava/util/Manifest.java
index 807eaa05f..58100535e 100644
--- a/src/main/java/org/scijava/util/Manifest.java
+++ b/src/main/java/org/scijava/util/Manifest.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/MersenneTwisterFast.java b/src/main/java/org/scijava/util/MersenneTwisterFast.java
index 2abb4d206..e1cdb4a48 100644
--- a/src/main/java/org/scijava/util/MersenneTwisterFast.java
+++ b/src/main/java/org/scijava/util/MersenneTwisterFast.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/MetaInfCombiner.java b/src/main/java/org/scijava/util/MetaInfCombiner.java
index 745c39195..3d03195f6 100644
--- a/src/main/java/org/scijava/util/MetaInfCombiner.java
+++ b/src/main/java/org/scijava/util/MetaInfCombiner.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/MirrorWebsite.java b/src/main/java/org/scijava/util/MirrorWebsite.java
index d8f076e40..2b5bdf4f9 100644
--- a/src/main/java/org/scijava/util/MirrorWebsite.java
+++ b/src/main/java/org/scijava/util/MirrorWebsite.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -58,7 +58,7 @@
* This program mirrors a given website.
*
* Its primary purpose is to provide the code necessary to keep ImageJ Mirror up-to-date.
+ * href="https://mirror.imagej.net/">ImageJ Mirror up-to-date.
*
*
* @author Johannes Schindelin
diff --git a/src/main/java/org/scijava/util/MiscUtils.java b/src/main/java/org/scijava/util/MiscUtils.java
index 492e2150e..eb9fad0c1 100644
--- a/src/main/java/org/scijava/util/MiscUtils.java
+++ b/src/main/java/org/scijava/util/MiscUtils.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/NumberUtils.java b/src/main/java/org/scijava/util/NumberUtils.java
index ea9f684ac..ba3fdc6d9 100644
--- a/src/main/java/org/scijava/util/NumberUtils.java
+++ b/src/main/java/org/scijava/util/NumberUtils.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -78,6 +78,8 @@ public static Number getMinimumNumber(final Class type) {
if (Types.isLong(type)) return Long.MIN_VALUE;
if (Types.isFloat(type)) return -Float.MAX_VALUE;
if (Types.isDouble(type)) return -Double.MAX_VALUE;
+ // Fallback for Number.class
+ if (Types.isNumber(type)) return -Double.MAX_VALUE;
return null;
}
@@ -88,6 +90,8 @@ public static Number getMaximumNumber(final Class type) {
if (Types.isLong(type)) return Long.MAX_VALUE;
if (Types.isFloat(type)) return Float.MAX_VALUE;
if (Types.isDouble(type)) return Double.MAX_VALUE;
+ // Fallback for Number.class
+ if (Types.isNumber(type)) return Double.MAX_VALUE;
return null;
}
diff --git a/src/main/java/org/scijava/util/ObjectArray.java b/src/main/java/org/scijava/util/ObjectArray.java
index 2564da853..daaa6e7ed 100644
--- a/src/main/java/org/scijava/util/ObjectArray.java
+++ b/src/main/java/org/scijava/util/ObjectArray.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -32,8 +32,6 @@
import java.util.Arrays;
import java.util.Collection;
-import org.scijava.util.Types;
-
/**
* An extensible, generic array of {@code Object} elements. Note that this class
* is a {@link PrimitiveArray} but of course Objects are not primitives.
diff --git a/src/main/java/org/scijava/util/POM.java b/src/main/java/org/scijava/util/POM.java
index 8de96e17f..ed7dc8009 100644
--- a/src/main/java/org/scijava/util/POM.java
+++ b/src/main/java/org/scijava/util/POM.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -335,7 +335,7 @@ public static List getAllPOMs() {
* that one has a suffix beginning with a dash ({@code -}), the version with
* suffix will be considered less than the one without a suffix. The
* reason for this is to accommodate the SemVer versioning scheme's usage of
+ * href="https://semver.org/">SemVer versioning scheme's usage of
* "prerelease" version suffixes. For example, {@code 2.0.0} will compare
* greater than {@code 2.0.0-beta-1}, whereas {@code 2.0.0} will compare less
* than {@code 2.0.0.1}. get(File filename) {
+ Map map = new HashMap<>();
+ try (BufferedReader reader = new BufferedReader(new FileReader(filename))) {
+ String line;
+ while ((line = reader.readLine()) != null) {
+ String[] parts = line.split("=", 2);
+ if (parts.length == 2) {
+ map.put(parts[0], parts[1]);
+ }
+ }
+ }
+ catch (FileNotFoundException e) {
+ throw new RuntimeException(e);
+ }
+ catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+ return map;
+ }
+
+ public static void put(Map properties, File filename) {
+ try (BufferedWriter writer = new BufferedWriter(new FileWriter(filename))) {
+ for (Map.Entry entry : properties.entrySet()) {
+ writer.write(entry.getKey() + "=" + entry.getValue());
+ writer.newLine();
+ }
+ }
+ catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+ }
+}
diff --git a/src/main/java/org/scijava/util/Query.java b/src/main/java/org/scijava/util/Query.java
index 2973c004e..7217b290e 100644
--- a/src/main/java/org/scijava/util/Query.java
+++ b/src/main/java/org/scijava/util/Query.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/ReadInto.java b/src/main/java/org/scijava/util/ReadInto.java
index 5e822926b..cefca34fd 100644
--- a/src/main/java/org/scijava/util/ReadInto.java
+++ b/src/main/java/org/scijava/util/ReadInto.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/RealCoords.java b/src/main/java/org/scijava/util/RealCoords.java
index d55f0cdfe..fd949dbbf 100644
--- a/src/main/java/org/scijava/util/RealCoords.java
+++ b/src/main/java/org/scijava/util/RealCoords.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/RealRect.java b/src/main/java/org/scijava/util/RealRect.java
index c58fbb7a8..507406235 100644
--- a/src/main/java/org/scijava/util/RealRect.java
+++ b/src/main/java/org/scijava/util/RealRect.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/ReflectException.java b/src/main/java/org/scijava/util/ReflectException.java
index 2096b73cf..bc4e0f246 100644
--- a/src/main/java/org/scijava/util/ReflectException.java
+++ b/src/main/java/org/scijava/util/ReflectException.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/ReflectedUniverse.java b/src/main/java/org/scijava/util/ReflectedUniverse.java
index 53c0e0ab7..c43a05dab 100644
--- a/src/main/java/org/scijava/util/ReflectedUniverse.java
+++ b/src/main/java/org/scijava/util/ReflectedUniverse.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/ServiceCombiner.java b/src/main/java/org/scijava/util/ServiceCombiner.java
index 65bf24190..64053aa7c 100644
--- a/src/main/java/org/scijava/util/ServiceCombiner.java
+++ b/src/main/java/org/scijava/util/ServiceCombiner.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -40,12 +40,10 @@
import java.util.Map;
import java.util.Map.Entry;
-import javax.xml.ws.Service;
-
import org.scijava.Context;
/**
- * Combines {@link Service} information from all JAR files on the classpath.
+ * Combines {@code Service} information from all JAR files on the classpath.
*
* @author Johannes Schindelin
* @author Mark Hiner
diff --git a/src/main/java/org/scijava/util/ShortArray.java b/src/main/java/org/scijava/util/ShortArray.java
index 50ca80a10..935bf6b96 100644
--- a/src/main/java/org/scijava/util/ShortArray.java
+++ b/src/main/java/org/scijava/util/ShortArray.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/Sizable.java b/src/main/java/org/scijava/util/Sizable.java
index b4939d7c8..21a1466d7 100644
--- a/src/main/java/org/scijava/util/Sizable.java
+++ b/src/main/java/org/scijava/util/Sizable.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/SizableArrayList.java b/src/main/java/org/scijava/util/SizableArrayList.java
index 163ae5939..889135a44 100644
--- a/src/main/java/org/scijava/util/SizableArrayList.java
+++ b/src/main/java/org/scijava/util/SizableArrayList.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/StringMaker.java b/src/main/java/org/scijava/util/StringMaker.java
index 97af599da..3df9b8786 100644
--- a/src/main/java/org/scijava/util/StringMaker.java
+++ b/src/main/java/org/scijava/util/StringMaker.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/StringUtils.java b/src/main/java/org/scijava/util/StringUtils.java
index 6516777b2..a38afb144 100644
--- a/src/main/java/org/scijava/util/StringUtils.java
+++ b/src/main/java/org/scijava/util/StringUtils.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/Timing.java b/src/main/java/org/scijava/util/Timing.java
index d533840f6..9cd4a1863 100644
--- a/src/main/java/org/scijava/util/Timing.java
+++ b/src/main/java/org/scijava/util/Timing.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/TreeNode.java b/src/main/java/org/scijava/util/TreeNode.java
index a0ed8a293..f302f9e59 100644
--- a/src/main/java/org/scijava/util/TreeNode.java
+++ b/src/main/java/org/scijava/util/TreeNode.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/TunePlayer.java b/src/main/java/org/scijava/util/TunePlayer.java
index a59e2019b..8ade8a695 100644
--- a/src/main/java/org/scijava/util/TunePlayer.java
+++ b/src/main/java/org/scijava/util/TunePlayer.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/Types.java b/src/main/java/org/scijava/util/Types.java
index 441516eaa..f9c9068a9 100644
--- a/src/main/java/org/scijava/util/Types.java
+++ b/src/main/java/org/scijava/util/Types.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -780,8 +780,10 @@ public static T cast(final Object src, final Class dest) {
}
/**
- * Converts the given string value to an enumeration constant of the specified
- * type.
+ * Converts the given string value to an enumeration constant of the
+ * specified type. For example, {@code enumValue("APPLE", Fruit.class)}
+ * returns {@code Fruit.APPLE} if such a value is among those of the
+ * requested enum class.
*
* @param name The value to convert.
* @param dest The type of the enumeration constant.
@@ -798,6 +800,60 @@ public static T enumValue(final String name, final Class dest) {
return typedResult;
}
+ /**
+ * Converts the given string label to an enumeration constant of the
+ * specified type. An enum label is the string returned by the enum constant's
+ * {@link Object#toString()} method. For example,
+ * {@code enumFromLabel("Apple", Fruit.class)} returns {@code Fruit.APPLE} if
+ * {@code Fruit.APPLE.toString()} is implemented to return {@code "Apple"}.
+ *
+ * @param label The {@code toString()} result of the desired enum value.
+ * @param dest The type of the enumeration constant.
+ * @return The matching enumeration constant.
+ * @throws IllegalArgumentException if the type is not an enumeration type, or
+ * has no constant with the given label.
+ */
+ public static T enumFromLabel(final String label, final Class dest) {
+ final T[] values = dest.getEnumConstants();
+ if (values == null) throw iae("Not an enum type: " + name(dest));
+ for (T value : values) {
+ if (Objects.equals(label, value.toString())) return value;
+ }
+ throw iae("Enum class " + dest.getName() + " has no such label: " + label);
+ }
+
+ /**
+ * Converts the given string value or label to an enumeration constant of the
+ * specified type.
+ *
+ * If the string matches one of the enum values directly, that value will be
+ * returned via {@link #enumValue(String, Class)}. Otherwise, the result of
+ * {@link #enumFromLabel} is returned.
+ *
+ *
+ * @param s The name or label of the desired enum value.
+ * @param dest The type of the enumeration constant.
+ * @return The matching enumeration constant.
+ * @throws IllegalArgumentException if the type is not an enumeration type,
+ * or has no such constant with the given name nor label.
+ */
+ public static T enumFromString(final String s, final Class dest) {
+ if (!dest.isEnum()) throw iae("Not an enum type: " + name(dest));
+ try {
+ return enumValue(s, dest);
+ }
+ catch (final IllegalArgumentException exc) {
+ // NB: No action needed.
+ }
+ try {
+ return enumFromLabel(s, dest);
+ }
+ catch (final IllegalArgumentException exc) {
+ // NB: No action needed.
+ }
+ throw iae("Enum class " + dest.getName() + " has no such value nor label: " + s);
+ }
+
/**
* Creates a new {@link ParameterizedType} of the given class together with
* the specified type arguments.
@@ -998,7 +1054,7 @@ private static Class arrayOrNull(final Class componentType) {
* (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
+ * https://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,
@@ -3485,8 +3541,6 @@ else if (type instanceof GenericArrayType) {
}
private static Type[] getArrayExactDirectSuperTypes(final Type arrayType) {
- // see
- // http://java.sun.com/docs/books/jls/third_edition/html/typesValues.html#4.10.3
final Type typeComponent = getArrayComponentType(arrayType);
Type[] result;
diff --git a/src/main/java/org/scijava/util/UnitUtils.java b/src/main/java/org/scijava/util/UnitUtils.java
index 1d45f7aac..43c13f1cb 100644
--- a/src/main/java/org/scijava/util/UnitUtils.java
+++ b/src/main/java/org/scijava/util/UnitUtils.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/VersionUtils.java b/src/main/java/org/scijava/util/VersionUtils.java
index 994a4aa71..2d7e97a32 100644
--- a/src/main/java/org/scijava/util/VersionUtils.java
+++ b/src/main/java/org/scijava/util/VersionUtils.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/util/XML.java b/src/main/java/org/scijava/util/XML.java
index e1b570d37..0dcbb1126 100644
--- a/src/main/java/org/scijava/util/XML.java
+++ b/src/main/java/org/scijava/util/XML.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/welcome/DefaultWelcomeService.java b/src/main/java/org/scijava/welcome/DefaultWelcomeService.java
index 186b28260..8977b0001 100644
--- a/src/main/java/org/scijava/welcome/DefaultWelcomeService.java
+++ b/src/main/java/org/scijava/welcome/DefaultWelcomeService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/welcome/WelcomeService.java b/src/main/java/org/scijava/welcome/WelcomeService.java
index c7a1ec948..8e2f77aec 100644
--- a/src/main/java/org/scijava/welcome/WelcomeService.java
+++ b/src/main/java/org/scijava/welcome/WelcomeService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/welcome/event/WelcomeEvent.java b/src/main/java/org/scijava/welcome/event/WelcomeEvent.java
index 8ea1f3424..6f9c5946c 100644
--- a/src/main/java/org/scijava/welcome/event/WelcomeEvent.java
+++ b/src/main/java/org/scijava/welcome/event/WelcomeEvent.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/widget/AbstractInputHarvester.java b/src/main/java/org/scijava/widget/AbstractInputHarvester.java
index 1f65ae1d5..0785fa157 100644
--- a/src/main/java/org/scijava/widget/AbstractInputHarvester.java
+++ b/src/main/java/org/scijava/widget/AbstractInputHarvester.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -30,9 +30,11 @@
package org.scijava.widget;
import java.util.ArrayList;
-import java.util.HashSet;
+import java.util.Arrays;
+import java.util.Collection;
import java.util.List;
import java.util.Set;
+import java.util.stream.Collectors;
import org.scijava.AbstractContextual;
import org.scijava.convert.ConvertService;
@@ -119,8 +121,15 @@ private WidgetModel addInput(final InputPanel inputPanel,
}
if (item.isRequired()) {
- throw new ModuleException("A " + type.getSimpleName() +
- " is required but none exist.");
+ final List vowelSoundPrefixes = Arrays.asList(
+ "a", "e", "i", "o", "u", "honor", "honour", "hour", "xml"
+ );
+ final String typeName = type.getSimpleName();
+ final String article = vowelSoundPrefixes.stream().anyMatch(
+ prefix -> typeName.toLowerCase().startsWith(prefix)
+ ) ? "An" : "A";
+ throw new ModuleException(article + " " + typeName +
+ " is required but none is available.");
}
// item is not required; we can skip it
@@ -128,13 +137,25 @@ private WidgetModel addInput(final InputPanel inputPanel,
}
/** Asks the object service and convert service for valid choices */
- @SuppressWarnings("unchecked")
- private List getObjects(final Class type) {
- @SuppressWarnings("rawtypes")
- Set compatibleInputs =
- new HashSet(convertService.getCompatibleInputs(type));
- compatibleInputs.addAll(objectService.getObjects(type));
- return new ArrayList<>(compatibleInputs);
+ private List getObjects(final Class type) {
+ // Start with the known, unconverted objects of the desired type
+ List objects = new ArrayList<>(objectService.getObjects(type));
+
+ // Get all the known objects that can be converted to the destination type
+ Collection compatibleInputs = convertService.getCompatibleInputs(type);
+
+ // HACK: Add each convertible object that doesn't share a name with any other object
+ // Our goal here is to de-duplicate by avoiding similar inputs that could be converted
+ // to the same effective output (e.g. an ImageDisplay and a Dataset that map to the same
+ // ImgPlus)
+ Set knownNames = objects.stream().map(Object::toString).collect(Collectors.toSet());
+ for (Object o : compatibleInputs) {
+ final String s = o.toString();
+ if (!knownNames.contains(s)) {
+ objects.add(o);
+ knownNames.add(s);
+ }
+ }
+ return objects;
}
-
}
diff --git a/src/main/java/org/scijava/widget/AbstractInputPanel.java b/src/main/java/org/scijava/widget/AbstractInputPanel.java
index 2a8bb49a5..756f5ed15 100644
--- a/src/main/java/org/scijava/widget/AbstractInputPanel.java
+++ b/src/main/java/org/scijava/widget/AbstractInputPanel.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/widget/AbstractInputWidget.java b/src/main/java/org/scijava/widget/AbstractInputWidget.java
index f527847b0..b6304cfd3 100644
--- a/src/main/java/org/scijava/widget/AbstractInputWidget.java
+++ b/src/main/java/org/scijava/widget/AbstractInputWidget.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/widget/Button.java b/src/main/java/org/scijava/widget/Button.java
index 286cd1fb4..3ddfa0217 100644
--- a/src/main/java/org/scijava/widget/Button.java
+++ b/src/main/java/org/scijava/widget/Button.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/widget/ButtonWidget.java b/src/main/java/org/scijava/widget/ButtonWidget.java
index c869fc13e..c836c522d 100644
--- a/src/main/java/org/scijava/widget/ButtonWidget.java
+++ b/src/main/java/org/scijava/widget/ButtonWidget.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/widget/ChoiceWidget.java b/src/main/java/org/scijava/widget/ChoiceWidget.java
index b900ac0ba..275b39607 100644
--- a/src/main/java/org/scijava/widget/ChoiceWidget.java
+++ b/src/main/java/org/scijava/widget/ChoiceWidget.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/widget/ColorWidget.java b/src/main/java/org/scijava/widget/ColorWidget.java
index 84284a9dd..93573a5ca 100644
--- a/src/main/java/org/scijava/widget/ColorWidget.java
+++ b/src/main/java/org/scijava/widget/ColorWidget.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/widget/DateWidget.java b/src/main/java/org/scijava/widget/DateWidget.java
index d05049bf7..ecd9953cb 100644
--- a/src/main/java/org/scijava/widget/DateWidget.java
+++ b/src/main/java/org/scijava/widget/DateWidget.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/widget/DefaultWidgetModel.java b/src/main/java/org/scijava/widget/DefaultWidgetModel.java
index 229195289..e7d6b9352 100644
--- a/src/main/java/org/scijava/widget/DefaultWidgetModel.java
+++ b/src/main/java/org/scijava/widget/DefaultWidgetModel.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -29,7 +29,6 @@
package org.scijava.widget;
-import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Objects;
@@ -80,6 +79,8 @@ public class DefaultWidgetModel extends AbstractContextual implements WidgetMode
private boolean initialized;
+ private String validationMessage;
+
public DefaultWidgetModel(final Context context, final InputPanel inputPanel,
final Module module, final ModuleItem item, final List objectPool)
{
@@ -156,6 +157,7 @@ public void setValue(final Object value) {
// Pass the value through the convertService
convertedInput = convertService.convert(value, item.getType());
+ if (convertedInput == null) convertedInput = value;
// If we get a different (converted) value back, cache it weakly.
if (convertedInput != value) {
@@ -167,6 +169,11 @@ public void setValue(final Object value) {
if (initialized) {
threadService.queue(() -> {
callback();
+ // Revalidate all inputs: changing one value may affect others' validity.
+ for (final ModuleItem anyItem : module.getInfo().inputs()) {
+ final InputWidget w = inputPanel.getWidget(anyItem.getName());
+ if (w != null) w.get().updateValidation();
+ }
inputPanel.refresh(); // must be on AWT thread?
module.preview();
});
@@ -220,7 +227,7 @@ public Number getStepSize() {
@Override
public String[] getChoices() {
- final List choicesList = item.getChoices();
+ final List choicesList = getItem().getChoices();
if (choicesList == null) return null;
final String[] choices = new String[choicesList.size()];
for (int i = 0; i < choices.length; i++) {
@@ -284,16 +291,25 @@ public boolean isInitialized() {
return initialized;
}
+ @Override
+ public String getValidationMessage() {
+ return validationMessage;
+ }
+
+ @Override
+ public void updateValidation() {
+ validationMessage = item.validateMessage(module);
+ }
+
// -- Helper methods --
/**
* For multiple choice widgets, ensures the value is a valid choice.
*
- * @see #getChoices()
* @see ChoiceWidget
*/
private Object ensureValidChoice(final Object value) {
- return ensureValid(value, Arrays.asList(getChoices()));
+ return ensureValid(value, getItem().getChoices());
}
/**
diff --git a/src/main/java/org/scijava/widget/DefaultWidgetService.java b/src/main/java/org/scijava/widget/DefaultWidgetService.java
index 2606eed13..7ceaf2c45 100644
--- a/src/main/java/org/scijava/widget/DefaultWidgetService.java
+++ b/src/main/java/org/scijava/widget/DefaultWidgetService.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/widget/FileListWidget.java b/src/main/java/org/scijava/widget/FileListWidget.java
index d74ea12f5..466f51d2f 100644
--- a/src/main/java/org/scijava/widget/FileListWidget.java
+++ b/src/main/java/org/scijava/widget/FileListWidget.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
diff --git a/src/main/java/org/scijava/widget/FileWidget.java b/src/main/java/org/scijava/widget/FileWidget.java
index dc70e0ce1..dcf38039d 100644
--- a/src/main/java/org/scijava/widget/FileWidget.java
+++ b/src/main/java/org/scijava/widget/FileWidget.java
@@ -2,7 +2,7 @@
* #%L
* SciJava Common shared library for SciJava software.
* %%
- * Copyright (C) 2009 - 2022 SciJava developers.
+ * Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -59,4 +59,11 @@ public interface FileWidget extends InputWidget