org.openksavi.sponge.core.util

Class Utils

java.lang.Object

org.openksavi.sponge.core.util.Utils

public abstract class Utils
extends Object

This class defines a set of utility methods. It also wraps some of the external dependencies like Guava to avoid version conflicts in the client code. All Sponge projects except sponge-core should use only such wrapper methods defined here.

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static int	calculateInitialDynamicThreadPoolSize(org.openksavi.sponge.engine.Engine engine, int maxPoolSize)
static void	close(InputStream stream)
static void	close(OutputStream stream)
static boolean	containsException(Throwable exception, Class<?> type)
static String	createControlEventName(Class<? extends org.openksavi.sponge.event.ControlEvent> controlEventClass)
static String	createGlobalLoggerName(org.openksavi.sponge.kb.KnowledgeBaseEngineOperations knowledgeBaseEngineOperations)
static String	createLoggerName(org.openksavi.sponge.kb.KnowledgeBase knowledgeBase, String targetName)
static String	createPluginLoggerName()
static <T extends Serializable> T	deepClone(T source)
static String	dumpConfiguration(org.apache.commons.configuration2.Configuration configuration) Dumps configuration to string.
static void	executeConcurrentlyOnce(org.openksavi.sponge.engine.Engine engine, Runnable runnable)
static String	getAbbreviatedEventSequenceString(BaseRule rule)
static org.openksavi.sponge.kb.KnowledgeBaseEngineOperations	getEps(org.openksavi.sponge.kb.KnowledgeBaseInterpreter interpreter)
static <T> T	getException(Throwable exception, Class<T> type)
static String	getLastSubdirectory(String dir)
static String	getPackagePath(Class<?> cls)
static Reader	getReader(String fileName)
static Reader	getReader(String fileName, Charset charset)
static String	getRequiredConfigurationString(org.openksavi.sponge.config.Configuration configuration, String key)
static org.openksavi.sponge.kb.ScriptKnowledgeBaseInterpreter	getScriptInterpreter(org.openksavi.sponge.engine.Engine engine, String kbName)
static String	getSourceName(Throwable exception)
static URL	getUrlFromClasspath(String resourceName)
static <K,V> Map<K,V>	immutableMapOf(K k1, V v1)
static <K,V> Map<K,V>	immutableMapOf(K k1, V v1, K k2, V v2)
static <K,V> Map<K,V>	immutableMapOf(K k1, V v1, K k2, V v2, K k3, V v3)
static <K,V> Map<K,V>	immutableMapOf(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)
static <K,V> Map<K,V>	immutableMapOf(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5)
static Object	searchConfigurationValueByAttributeValue(org.openksavi.sponge.config.Configuration root, String parentKey, String attrName, String attrValue)
static void	shutdownExecutorService(org.openksavi.sponge.engine.Engine engine, Object named, ExecutorService executorService)
static List<String>	split(String text, char separator)
static <T> Stream<T>	stream(Iterator<T> iterator)
static String	toStringArrayEventSequence(Collection<org.openksavi.sponge.event.Event> events, String attributeName)
static String	toStringEventSequence(Collection<org.openksavi.sponge.event.Event> events)
static String	toStringEventSequence(Collection<org.openksavi.sponge.event.Event> events, String attributeName)
static void	trialRunEngine(org.openksavi.sponge.engine.Engine engine, int timeout) Trial run of the engine.
static org.openksavi.sponge.SpongeException	wrapException(String sourceName, Throwable throwable) Wraps or creates a new Sponge exception.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Utils

public Utils()

Method Detail

trialRunEngine

public static void trialRunEngine(org.openksavi.sponge.engine.Engine engine,
                                  int timeout)

Trial run of the engine. Shuts down after timeout seconds after startup.

Parameters:

engine - the engine.

timeout - timeout in seconds.

deepClone

public static <T extends Serializable> T deepClone(T source)

getReader

public static Reader getReader(String fileName)
                        throws IOException

Throws:

IOException

getReader

public static Reader getReader(String fileName,
                               Charset charset)
                        throws IOException

Throws:

IOException

getUrlFromClasspath

public static URL getUrlFromClasspath(String resourceName)

dumpConfiguration

public static String dumpConfiguration(org.apache.commons.configuration2.Configuration configuration)

Dumps configuration to string.

Parameters:

configuration - a configuration.

Returns:

a configuration dump string.

searchConfigurationValueByAttributeValue

public static Object searchConfigurationValueByAttributeValue(org.openksavi.sponge.config.Configuration root,
                                                              String parentKey,
                                                              String attrName,
                                                              String attrValue)

executeConcurrentlyOnce

public static void executeConcurrentlyOnce(org.openksavi.sponge.engine.Engine engine,
                                           Runnable runnable)

createGlobalLoggerName

public static String createGlobalLoggerName(org.openksavi.sponge.kb.KnowledgeBaseEngineOperations knowledgeBaseEngineOperations)

createPluginLoggerName

public static String createPluginLoggerName()

createLoggerName

public static String createLoggerName(org.openksavi.sponge.kb.KnowledgeBase knowledgeBase,
                                      String targetName)

shutdownExecutorService

public static void shutdownExecutorService(org.openksavi.sponge.engine.Engine engine,
                                           Object named,
                                           ExecutorService executorService)

getScriptInterpreter

public static org.openksavi.sponge.kb.ScriptKnowledgeBaseInterpreter getScriptInterpreter(org.openksavi.sponge.engine.Engine engine,
                                                                                          String kbName)

getEps

public static org.openksavi.sponge.kb.KnowledgeBaseEngineOperations getEps(org.openksavi.sponge.kb.KnowledgeBaseInterpreter interpreter)

getAbbreviatedEventSequenceString

public static String getAbbreviatedEventSequenceString(BaseRule rule)

wrapException

public static org.openksavi.sponge.SpongeException wrapException(String sourceName,
                                                                 Throwable throwable)

Wraps or creates a new Sponge exception.

Parameters:

sourceName - source name of the exception.

throwable - source throwable.

Returns:

Sponge exception.

containsException

public static boolean containsException(Throwable exception,
                                        Class<?> type)

getException

public static <T> T getException(Throwable exception,
                                 Class<T> type)

getSourceName

public static String getSourceName(Throwable exception)

toStringEventSequence

public static String toStringEventSequence(Collection<org.openksavi.sponge.event.Event> events)

toStringEventSequence

public static String toStringEventSequence(Collection<org.openksavi.sponge.event.Event> events,
                                           String attributeName)

toStringArrayEventSequence

public static String toStringArrayEventSequence(Collection<org.openksavi.sponge.event.Event> events,
                                                String attributeName)

createControlEventName

public static String createControlEventName(Class<? extends org.openksavi.sponge.event.ControlEvent> controlEventClass)

calculateInitialDynamicThreadPoolSize

public static int calculateInitialDynamicThreadPoolSize(org.openksavi.sponge.engine.Engine engine,
                                                        int maxPoolSize)

getPackagePath

public static String getPackagePath(Class<?> cls)

getLastSubdirectory

public static String getLastSubdirectory(String dir)

immutableMapOf

public static <K,V> Map<K,V> immutableMapOf(K k1,
                                            V v1)

immutableMapOf

public static <K,V> Map<K,V> immutableMapOf(K k1,
                                            V v1,
                                            K k2,
                                            V v2)

immutableMapOf

public static <K,V> Map<K,V> immutableMapOf(K k1,
                                            V v1,
                                            K k2,
                                            V v2,
                                            K k3,
                                            V v3)

immutableMapOf

public static <K,V> Map<K,V> immutableMapOf(K k1,
                                            V v1,
                                            K k2,
                                            V v2,
                                            K k3,
                                            V v3,
                                            K k4,
                                            V v4)

immutableMapOf

public static <K,V> Map<K,V> immutableMapOf(K k1,
                                            V v1,
                                            K k2,
                                            V v2,
                                            K k3,
                                            V v3,
                                            K k4,
                                            V v4,
                                            K k5,
                                            V v5)

stream

public static <T> Stream<T> stream(Iterator<T> iterator)

split

public static List<String> split(String text,
                                 char separator)

close

public static void close(InputStream stream)

close

public static void close(OutputStream stream)

getRequiredConfigurationString

public static String getRequiredConfigurationString(org.openksavi.sponge.config.Configuration configuration,
                                                    String key)