org.springframework.plugin.core

Interface PluginRegistry<T extends Plugin<S>,S>

Type Parameters:

T - the concrete Plugin interface

S - the delimiter type

All Superinterfaces:

Iterable<T>

All Known Implementing Classes:

OrderAwarePluginRegistry, PluginRegistrySupport, SimplePluginRegistry

public interface PluginRegistry<T extends Plugin<S>,S>
extends Iterable<T>

Registry for Plugins. Allows sophisticated typesafe access to implementations of interfaces extending {link Plugin}.

Author:

Oliver Gierke

Method Summary

Modifier and Type	Method and Description
boolean	contains(T plugin) Returns whether the registry contains a given plugin.
int	countPlugins() Returns the number of registered plugins.
static <S,T extends Plugin<S>> PluginRegistry<T,S>	empty() Creates a new PluginRegistry using the #DEFAULT_COMPARATOR.
Optional<T>	getPluginFor(S delimiter) Returns the first Plugin found for the given delimiter.
<E extends Exception> T	getPluginFor(S delimiter, Supplier<E> ex) Retrieves a required plugin from the registry or throw the given exception if none can be found.
T	getPluginOrDefaultFor(S delimiter, Supplier<T> defaultSupplier) Returns the first Plugin supporting the given delimiter or the given lazily-provided plugin if none can be found.
T	getPluginOrDefaultFor(S delimiter, T plugin) Returns the first Plugin supporting the given delimiter or the given plugin if none can be found.
List<T>	getPlugins() Returns all Plugins contained in this registry.
List<T>	getPluginsFor(S delimiter) Returns all plugins for the given delimiter.
List<T>	getPluginsFor(S delimiter, List<? extends T> plugins) Returns all Plugins supporting the given delimiter or the given plugins if none found.
<E extends Exception> List<T>	getPluginsFor(S delimiter, Supplier<E> ex) Retrieves all plugins for the given delimiter or throws an exception if no plugin can be found.
T	getRequiredPluginFor(S delimiter) Returns the first Plugin found for the given delimiter.
T	getRequiredPluginFor(S delimiter, Supplier<String> message) Returns the first Plugin found for the given delimiter.
boolean	hasPluginFor(S delimiter) Returns whether the registry contains a Plugin matching the given delimiter.
static <S,T extends Plugin<S>> PluginRegistry<T,S>	of(Comparator<? super T> comparator) Creates a new PluginRegistry using the given Comparator for ordering contained Plugins.
static <S,T extends Plugin<S>> PluginRegistry<T,S>	of(List<? extends T> plugins) Creates a new OrderAwarePluginRegistry with the given plugins.
static <S,T extends Plugin<S>> PluginRegistry<T,S>	of(List<? extends T> plugins, Comparator<? super T> comparator) Creates a new OrderAwarePluginRegistry with the given plugins.
static <S,T extends Plugin<S>> PluginRegistry<T,S>	of(T... plugins) Creates a new PluginRegistry with the given plugins.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

empty

static <S,T extends Plugin<S>> PluginRegistry<T,S> empty()

Creates a new PluginRegistry using the #DEFAULT_COMPARATOR.

Returns:

Since:

2.0

of

static <S,T extends Plugin<S>> PluginRegistry<T,S> of(Comparator<? super T> comparator)

Creates a new PluginRegistry using the given Comparator for ordering contained Plugins.

Parameters:

comparator - must not be null.

Returns:

Since:

2.0

of

@SafeVarargs
static <S,T extends Plugin<S>> PluginRegistry<T,S> of(T... plugins)

Creates a new PluginRegistry with the given plugins.

Parameters:

plugins - must not be null.

Returns:

Since:

2.0

of

static <S,T extends Plugin<S>> PluginRegistry<T,S> of(List<? extends T> plugins)

Creates a new OrderAwarePluginRegistry with the given plugins.

Parameters:

plugins - must not be null.

Returns:

Since:

2.0

of

static <S,T extends Plugin<S>> PluginRegistry<T,S> of(List<? extends T> plugins,
                                                      Comparator<? super T> comparator)

Creates a new OrderAwarePluginRegistry with the given plugins.

Parameters:

plugins -

Returns:

Since:

2.0

getPluginFor

Optional<T> getPluginFor(S delimiter)

Returns the first Plugin found for the given delimiter. Thus, further configured Plugins are ignored.

Parameters:

delimiter - must not be null.

Returns:

a plugin for the given delimiter or Optional.empty() if none found.

getRequiredPluginFor

T getRequiredPluginFor(S delimiter)
                throws IllegalArgumentException

Returns the first Plugin found for the given delimiter. Thus, further configured Plugins are ignored.

Parameters:

delimiter - must not be null.

Returns:

a Plugin for the given originating system or Optional.empty() if none found.

Throws:

IllegalArgumentException - in case no Plugin for the given delimiter

getRequiredPluginFor

T getRequiredPluginFor(S delimiter,
                       Supplier<String> message)
                throws IllegalArgumentException

Returns the first Plugin found for the given delimiter. Thus, further configured Plugins are ignored.

Parameters:

delimiter - must not be null.

message - a Supplier to produce an exception message in case no plugin is found.

Returns:

a Plugin for the given originating system or Optional.empty() if none found.

Throws:

IllegalArgumentException - in case no Plugin for the given delimiter

getPluginsFor

List<T> getPluginsFor(S delimiter)

Returns all plugins for the given delimiter.

Parameters:

delimiter - must not be null.

Returns:

a list of plugins or an empty list if none found

getPluginFor

<E extends Exception> T getPluginFor(S delimiter,
                                     Supplier<E> ex)
                              throws E extends Exception

Retrieves a required plugin from the registry or throw the given exception if none can be found. If more than one plugins are found the first one will be returned.

Type Parameters:

E - the exception type to be thrown in case no plugin can be found.

Parameters:

delimiter - must not be null.

ex - a lazy Supplier to produce an exception in case no plugin can be found, must not be null.

Returns:

a single plugin for the given delimiter

Throws:

E - if no plugin can be found for the given delimiter

E extends Exception

getPluginsFor

<E extends Exception> List<T> getPluginsFor(S delimiter,
                                            Supplier<E> ex)
                                     throws E extends Exception

Retrieves all plugins for the given delimiter or throws an exception if no plugin can be found.

Type Parameters:

E - the exception type to be thrown.

Parameters:

delimiter - must not be null.

ex - a lazy Supplier to produce an exception in case no plugin can be found, must not be null.

Returns:

all plugins for the given delimiter

Throws:

E - if no plugin can be found

E extends Exception

getPluginOrDefaultFor

T getPluginOrDefaultFor(S delimiter,
                        T plugin)

Returns the first Plugin supporting the given delimiter or the given plugin if none can be found.

Parameters:

delimiter - must not be null.

plugin - must not be null.

Returns:

a single Plugin supporting the given delimiter or the given Plugin if none found

getPluginOrDefaultFor

T getPluginOrDefaultFor(S delimiter,
                        Supplier<T> defaultSupplier)

Returns the first Plugin supporting the given delimiter or the given lazily-provided plugin if none can be found.

Parameters:

delimiter - can be null.

defaultSupplier - must not be null.

Returns:

a single Plugin supporting the given delimiter or the given lazily provided Plugin if none found.

getPluginsFor

List<T> getPluginsFor(S delimiter,
                      List<? extends T> plugins)

Returns all Plugins supporting the given delimiter or the given plugins if none found.

Parameters:

delimiter - must not be null.

plugins - must not be null.

Returns:

all Plugins supporting the given delimiter or the given Plugins if none found, will never be null.

countPlugins

int countPlugins()

Returns the number of registered plugins.

Returns:

the number of plugins in the registry

contains

boolean contains(T plugin)

Returns whether the registry contains a given plugin.

Parameters:

plugin - must not be null.

Returns:

hasPluginFor

boolean hasPluginFor(S delimiter)

Returns whether the registry contains a Plugin matching the given delimiter.

Parameters:

delimiter - must not be null.

Returns:

getPlugins

List<T> getPlugins()

Returns all Plugins contained in this registry. Will return an immutable List to prevent outside modifications of the PluginRegistry content.

Returns:

will never be null.