A B C D F G H I K L N O P R S V

A

add(String, Class<?>) - Method in class org.pfsw.plugin.BasePluginRegistration
Add an entry to the registration data.
addDefinitionsToRegistry(OrderedProperties<?>) - Method in class org.pfsw.plugin.PluginRegistry
 
addMappings(Properties) - Method in class org.pfsw.plugin.PluginCollector
 
addMappings(Map<String, Class<?>>) - Method in class org.pfsw.plugin.PluginCollector
 
assertArgNotNull(String, String, Object) - Method in class org.pfsw.plugin.ClassRegistry
 
assertClassFound(ClassInfo<T>) - Method in class org.pfsw.plugin.ClassRegistry
 
assertInstanceCreation(ClassInfo<T>) - Method in class org.pfsw.plugin.ClassRegistry
 
assertValidType(ClassInfo<T>) - Method in class org.pfsw.plugin.ClassRegistry
 
autoLoadPlugins(ClassLoader) - Method in class org.pfsw.plugin.PluginLoader
 

B

BasePluginRegistration - Class in org.pfsw.plugin
An abstract implementation of the PluginRegistration interface that can be extended and filled with the relevant data by overriding the BasePluginRegistration.initialize() method.
BasePluginRegistration() - Constructor for class org.pfsw.plugin.BasePluginRegistration
 

C

classes() - Method in class org.pfsw.plugin.ClassRegistry
Returns all class objects that are currently in this registry.
classNames() - Method in class org.pfsw.plugin.ClassRegistry
Returns all class names of the classes that are currently in this registry.
ClassRegistry<T> - Class in org.pfsw.plugin
A class registry is a container that keeps classes registered under a logical key.
ClassRegistry() - Constructor for class org.pfsw.plugin.ClassRegistry
Initialize the new instance with default values.
ClassRegistry(Class<T>) - Constructor for class org.pfsw.plugin.ClassRegistry
Initialize the new instance with a type all classes that are registered must comply to.
ClassRegistryException - Exception in org.pfsw.plugin
A generic exception for all problems that occur within the class registry.
ClassRegistryException(String) - Constructor for exception org.pfsw.plugin.ClassRegistryException
Initialize the new instance with a message.
clear() - Method in class org.pfsw.plugin.PluginRegistry
Remove all registered plugins.
coll() - Method in class org.pfsw.plugin.PluginRegistry
 
collectClasses() - Method in class org.pfsw.plugin.ClassRegistry
Returns all classes that are currently in this registry.
collectNames() - Method in class org.pfsw.plugin.ClassRegistry
Returns all class names that are currently in this registry.
collUtil() - Method in class org.pfsw.plugin.PluginUtil
 
createInstanceFromServiceDeclaration(ClassLoader) - Method in class org.pfsw.plugin.PluginLoader
 
current() - Static method in class org.pfsw.plugin.PluginUtil
Returns the only instance this class supports (design pattern "Singleton")

D

DEBUG - Static variable in class org.pfsw.plugin.PluginCollector
 
debug(String) - Method in class org.pfsw.plugin.PluginCollector
 
DEBUG - Static variable in class org.pfsw.plugin.PluginRegistry
 
debug(String) - Method in class org.pfsw.plugin.PluginRegistry
 
DEBUG_PREFIX - Static variable in class org.pfsw.plugin.PluginCollector
 
DEBUG_PREFIX - Static variable in class org.pfsw.plugin.PluginRegistry
 
defaultToFirstEntry() - Method in class org.pfsw.plugin.PluginLoader
The return value of this method defines if the first entry in the found plugins should be returned as default if no explicit alias name has been provided in the configuration settings.
determineClassLoader(ClassLoader) - Method in class org.pfsw.plugin.PluginLoader
 

F

fileUtil() - Method in class org.pfsw.plugin.PluginCollector
 
fileUtil() - Method in class org.pfsw.plugin.PluginRegistry
 
fileUtil() - Method in class org.pfsw.plugin.PluginUtil
 
find_getPluginId_Method(Object) - Method in class org.pfsw.plugin.PluginRegistry
 

G

get(Object) - Method in class org.pfsw.plugin.ClassRegistry
 
getAliasConfigParamName() - Method in class org.pfsw.plugin.PluginLoader
 
getAllPluginsViaPluginRegistration() - Method in class org.pfsw.plugin.PluginLoader
Returns all plugins that can be found via the PluginRegistration mechanism for the underlying interface definition.
getAllPluginsViaPluginRegistration(ClassLoader) - Method in class org.pfsw.plugin.PluginLoader
Returns all plugins that can be found via the PluginRegistration mechanism for the underlying interface definition using the given class loader as preferred class loader for the Java ServiceLoader lookup.
getClass(String) - Method in class org.pfsw.plugin.ClassRegistry
Returns the class which is registered under the given key.
getClassesToRegister() - Method in class org.pfsw.plugin.BasePluginRegistration
 
getClassesToRegister() - Method in interface org.pfsw.plugin.PluginRegistration
Returns a map with all classes that should be registered for dynamic instantiation.
getClassInfo(String) - Method in class org.pfsw.plugin.ClassRegistry
Returns the class information object stored under the given key or null if nothing is found.
getClassLoader(ClassLoader...) - Method in class org.pfsw.plugin.PluginUtil
Returns the first non-null classloader from the following order: suggestedClassLoaders The current thread's context class loader the class loader of this class the system class loader or throws an IllegalStateException if no classloader can be found.
getClassName(Object) - Method in class org.pfsw.plugin.ClassRegistry
Returns the name of the class which is registered under the given key.
getClassNameConfigParamName() - Method in class org.pfsw.plugin.PluginLoader
 
getClassRegistry() - Method in class org.pfsw.plugin.PluginCollector
Returns the class registry that contains all loaded plugins.
getEntryType() - Method in class org.pfsw.plugin.ClassRegistry
 
getFirst() - Method in class org.pfsw.plugin.ClassRegistry
Returns the first class info object of null if the registry is empty.
getIdOfPlugin(Object, String) - Method in class org.pfsw.plugin.PluginRegistry
 
getInterfaceClass() - Method in class org.pfsw.plugin.PluginLoader
 
getLogger() - Static method in class org.pfsw.plugin.LoggerProvider
Returns the current logger used by this component to report errors and exceptions.
getParameterNames() - Method in class org.pfsw.plugin.PluginLoader
 
getPlugin(String) - Method in class org.pfsw.plugin.PluginRegistry
Returns the plug-in with the specified ID or null if no such plug-in can be found in the registry.
getPlugin(String, Class<T>) - Method in class org.pfsw.plugin.PluginRegistry
Returns the plug-in with the specified ID and the given type or null if no such plug-in can be found in the registry.
getPluginClasspath() - Method in class org.pfsw.plugin.PluginCollector
Returns the classpath that is used to lookup any plug-in information files.
getPluginClasspath() - Method in class org.pfsw.plugin.PluginRegistry
Returns the classpath that is used to lookup any plug-in information files.
getPluginClasspath() - Method in class org.pfsw.plugin.PluginUtil
Returns the classpath that is used to lookup any plug-in information files.
getPluginId() - Method in interface org.pfsw.plugin.IIdentifiablePlugin
Returns the identifier of the plugin (never null).
getPluginIDsOfType(Class<?>) - Method in class org.pfsw.plugin.PluginRegistry
Returns the IDs of all plug-ins that are of the specified type.
getPluginsOfType(Class<T>) - Method in class org.pfsw.plugin.PluginRegistry
Returns all plug-ins that are of the specified type.
getRegistrationMap() - Method in class org.pfsw.plugin.BasePluginRegistration
 
getRegistry() - Method in class org.pfsw.plugin.PluginRegistry
 

H

handleException(Exception) - Method in class org.pfsw.plugin.ClassRegistry
 

I

ID_METHOD_NAME - Static variable in interface org.pfsw.plugin.IIdentifiablePlugin
 
IIdentifiablePlugin - Interface in org.pfsw.plugin
This interface can optionally be implemented by plugins.
IInitializablePlugin - Interface in org.pfsw.plugin
Defines the methods needed to initialize a plug-in implementation right after its creation via its public no-argument constructor.
illegalArgumentException(String, String) - Method in class org.pfsw.plugin.ClassRegistry
 
initialize() - Method in class org.pfsw.plugin.BasePluginRegistration
Will be called from the constructor to fill the internal map with values.
initPlugin(String, Properties) - Method in interface org.pfsw.plugin.IInitializablePlugin
Initialize the newly created plug-in implementation with the externally defined ID and specified configuration properties.
isEmpty() - Method in class org.pfsw.plugin.ClassRegistry
 
isTyped() - Method in class org.pfsw.plugin.ClassRegistry
 
isValidType(Class<?>) - Method in class org.pfsw.plugin.ClassRegistry
Returns true if the given type is compatible to the underlying entry type.

K

keys() - Method in class org.pfsw.plugin.ClassRegistry
Returns all keys known in this registry.

L

loadFirstFoundInstance(ClassLoader) - Method in class org.pfsw.plugin.PluginLoader
Returns the and instance of the first found class definition.
loadInstance(ClassLoader, String) - Method in class org.pfsw.plugin.PluginLoader
Returns the instance for the given className.
loadInstance(ClassLoader, Class<TInterface>) - Method in class org.pfsw.plugin.PluginLoader
Returns the instance for the given class.
loadInstanceByAlias(ClassLoader, String) - Method in class org.pfsw.plugin.PluginLoader
Returns the instance for the given alias.
loadInstanceFromService(ClassLoader) - Method in class org.pfsw.plugin.PluginLoader
Returns the instance that is specified in the first META-INF/services/full-qualified-TInterface-name file on the classpath.
loadPlugin(IConfigSettings) - Method in class org.pfsw.plugin.PluginLoader
Returns the instance that is specified by class name configuration parameter or indirectly by the alias name optionally defined in the alias configuration parameter.
loadPlugin(ClassLoader, IConfigSettings, boolean) - Method in class org.pfsw.plugin.PluginLoader
Returns the instance that is specified by class name configuration parameter or indirectly by the alias name optionally defined in the alias configuration parameter.
loadPlugins(String) - Method in class org.pfsw.plugin.PluginCollector
Load the class definitions from all files with the given name that can be found in the system classpath.
loadPlugins(String, String) - Method in class org.pfsw.plugin.PluginCollector
Load the class definitions from all files with the given name that can be found in the specified classpath.
loadPlugins(String, Classpath) - Method in class org.pfsw.plugin.PluginCollector
Load the class definitions from all files with the given name that can be found in the specified classpath.
loadPluginsByServiceLoader(Class<T>, ClassLoader...) - Method in class org.pfsw.plugin.PluginRegistry
Utilizes the Java ServiceLoader mechanism to load all plugins implementing the given type into this registry.
loadPluginsFrom(String) - Method in class org.pfsw.plugin.PluginRegistry
Load all plug-ins that are defined in any library in the specified file.
loadPluginsViaClassLoader(String) - Method in class org.pfsw.plugin.PluginCollector
Load the class definitions from the file with the given name.
loadPluginsViaPluginRegistration(ClassLoader) - Method in class org.pfsw.plugin.PluginCollector
Load the class definitions from all PluginRegistration implementing classes that can be found via Java service loader mechanism in the given classloader's hierarchy.
loadPluginsViaPluginRegistration() - Method in class org.pfsw.plugin.PluginCollector
Load the class definitions from all PluginRegistration implementing classes that can be found via Java service loader mechanism using the classloader of this class.
LOGGER_NAME - Static variable in class org.pfsw.plugin.LoggerProvider
 
LoggerProvider - Class in org.pfsw.plugin
This is the central access point for the package's logger.

N

newInstance(String) - Method in class org.pfsw.plugin.ClassRegistry
Returns a new instance of the class which is registered under the given key.

O

OPTIONS_END - Static variable in class org.pfsw.plugin.PluginRegistry
 
OPTIONS_START - Static variable in class org.pfsw.plugin.PluginRegistry
 
org.pfsw.plugin - package org.pfsw.plugin
Plugin Utility Classes
A component that supports automatic collection of plugins from all elements in the classpath that comply to a specified interface/class.

P

parseAndAddToRegistry(String, String) - Method in class org.pfsw.plugin.PluginRegistry
 
PLUGIN_DEF_SEPARATOR - Static variable in class org.pfsw.plugin.PluginRegistry
 
PLUGIN_OPTIONS_PATTERN - Static variable in class org.pfsw.plugin.PluginRegistry
 
PluginCollector<TType> - Class in org.pfsw.plugin
The responsibility of this class is to detect all properties files with a specific name on a given classpath and load the defined classes that fit to a given class/interface into a class regitry.
PluginCollector() - Constructor for class org.pfsw.plugin.PluginCollector
Initialize the new instance with default values.
PluginCollector(Class<TType>) - Constructor for class org.pfsw.plugin.PluginCollector
Initialize the new instance the type the plugins to collect must be compliant with.
PluginCollector(ClassRegistry<TType>) - Constructor for class org.pfsw.plugin.PluginCollector
Initialize the new instance with a class registry.
PluginLoader<TInterface> - Class in org.pfsw.plugin
An abstract class that implements the generic logic to load a configured implementation class for a specific interface through different variants of loading mechanisms.
PluginLoader(Class<TInterface>, String, String) - Constructor for class org.pfsw.plugin.PluginLoader
 
PluginRegistration - Interface in org.pfsw.plugin
Implementations of this interface provide alias names with associated classes that will be registered for dynamic instantiation.
PluginRegistry - Class in org.pfsw.plugin
A special registry that is capable to hold any number of plug-ins of any type.
PluginRegistry() - Constructor for class org.pfsw.plugin.PluginRegistry
Initialize the new instance with default values (i.e. an empty registry).
pluginUtil() - Method in class org.pfsw.plugin.PluginCollector
 
pluginUtil() - Method in class org.pfsw.plugin.PluginLoader
 
PluginUtil - Class in org.pfsw.plugin
Provides helper methods around the PF plug-in mechanism.
PluginUtil() - Constructor for class org.pfsw.plugin.PluginUtil
Initialize the new instance with default values.
plugUtil() - Method in class org.pfsw.plugin.PluginRegistry
 
PU - Static variable in class org.pfsw.plugin.PluginUtil
 
put(String, String) - Method in class org.pfsw.plugin.ClassRegistry
Registers the class with the given name under the specified key.
put(String, Class<T>) - Method in class org.pfsw.plugin.ClassRegistry
Registers the given class under the specified key.
put(String, ClassInfo<T>) - Method in class org.pfsw.plugin.ClassRegistry
 

R

readMapping(ClasspathElement, String) - Method in class org.pfsw.plugin.PluginCollector
 
readMapping(InputStream, String) - Method in class org.pfsw.plugin.PluginCollector
Reads all plugin definitions from the given stream into the underlying registry.
readPlugins(String, String) - Method in class org.pfsw.plugin.PluginCollector
Read all classes specified in the given file, if it exists in the specified classpath element.
readPlugins(String, Classpath) - Method in class org.pfsw.plugin.PluginCollector
Read all classes specified in the given file, if it exists in the specified classpath element.
readPlugins(String, Classpath) - Method in class org.pfsw.plugin.PluginRegistry
Read all classes specified in the given file, if it exists in the specified classpath element.
readPluginsFrom(ClasspathElement, String) - Method in class org.pfsw.plugin.PluginRegistry
 
register(String, String) - Method in class org.pfsw.plugin.ClassRegistry
Registers the class with the given name under the specified key.
register(String, Class<T>) - Method in class org.pfsw.plugin.ClassRegistry
Registers the class under the specified key.
registerPlugin(PluginHolder) - Method in class org.pfsw.plugin.PluginRegistry
 
registerPlugin(Class<T>, T) - Method in class org.pfsw.plugin.PluginRegistry
 
registry() - Method in class org.pfsw.plugin.ClassRegistry
 
registry(Map<String, ClassInfo<T>>) - Method in class org.pfsw.plugin.ClassRegistry
 
remove(Object) - Method in class org.pfsw.plugin.ClassRegistry
Removes the entry in the registry which is defined by the given key.

S

setClassRegistry(ClassRegistry<TType>) - Method in class org.pfsw.plugin.PluginCollector
 
setEntryType(Class<T>) - Method in class org.pfsw.plugin.ClassRegistry
 
setLogger(Logger) - Static method in class org.pfsw.plugin.LoggerProvider
Replace the logger by another one.
setRegistry(NamedValueList<PluginHolder>) - Method in class org.pfsw.plugin.PluginRegistry
 
size() - Method in class org.pfsw.plugin.ClassRegistry
 
str() - Method in class org.pfsw.plugin.PluginRegistry
 
SYS_PROP_PLUGIN_PATH - Static variable in class org.pfsw.plugin.PluginUtil
 

V

validate(ClassInfo<T>) - Method in class org.pfsw.plugin.ClassRegistry
 
validateClass(ClassInfo<?>) - Method in class org.pfsw.plugin.PluginRegistry
 
validateClassFound(ClassInfo<?>) - Method in class org.pfsw.plugin.PluginRegistry
 
validateInstanceCreation(ClassInfo<?>) - Method in class org.pfsw.plugin.PluginRegistry
 
values() - Method in class org.pfsw.plugin.ClassRegistry
Returns all class info objects that are currently in this registry.

A B C D F G H I K L N O P R S V