org.apache.logging.log4j.core.config.plugins.util

Class PluginUtil

java.lang.Object

org.apache.logging.log4j.core.config.plugins.util.PluginUtil

public final class PluginUtil
extends Object

Plugin utilities.

See Also:

PluginManager

Method Summary

Modifier and Type	Method and Description
static Map<String,PluginType<?>>	collectPluginsByCategory(String category) Shortcut for collecting plugins matching with the given category.
static Map<String,PluginType<?>>	collectPluginsByCategoryAndPackage(String category, List<String> packages) Short for collecting plugins matching with the given category in provided packages.
static Method	findPluginFactoryMethod(Class<?> pluginClass) Finds the PluginFactory-annotated static method of the given class.
static <V> V	instantiatePlugin(Class<V> pluginClass) Instantiates the given plugin using its no-arg PluginFactory-annotated static method.

Methods inherited from class java.lang.Object

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

Method Detail

collectPluginsByCategory

public static Map<String,PluginType<?>> collectPluginsByCategory(String category)

Shortcut for collecting plugins matching with the given category.

collectPluginsByCategoryAndPackage

public static Map<String,PluginType<?>> collectPluginsByCategoryAndPackage(String category,
                                                                           List<String> packages)

Short for collecting plugins matching with the given category in provided packages.

instantiatePlugin

public static <V> V instantiatePlugin(Class<V> pluginClass)

Instantiates the given plugin using its no-arg PluginFactory-annotated static method.

Throws:

IllegalStateException - if instantiation fails

findPluginFactoryMethod

public static Method findPluginFactoryMethod(Class<?> pluginClass)

Finds the PluginFactory-annotated static method of the given class.

Throws:

IllegalStateException - if no such method could be found