SimplePluginRegistry (Spring Plugin - Core 2.0.0.RELEASE API)

java.lang.Object
- org.springframework.plugin.core.PluginRegistrySupport<T,S>
- - org.springframework.plugin.core.SimplePluginRegistry<T,S>

All Implemented Interfaces:

Iterable<T>, PluginRegistry<T,S>

Direct Known Subclasses:

OrderAwarePluginRegistry
```
public class SimplePluginRegistry<T extends Plugin<S>,S>
extends PluginRegistrySupport<T,S>
```
Basic implementation of PluginRegistry. Simply holds all given plugins in a list dropping null values silently on adding.

Author:

Oliver Gierke

Constructor Summary

Constructors
Modifier Constructor and Description

protected SimplePluginRegistry(List<? extends T> plugins)
Creates a new SimplePluginRegistry.

Constructors
Modifier	Constructor and Description
`protected`	`SimplePluginRegistry(List<? extends T> plugins)` Creates a new `SimplePluginRegistry`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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>> SimplePluginRegistry<T,S>`	`create()` Deprecated. use `empty()` instead.
`static <S,T extends Plugin<S>> SimplePluginRegistry<T,S>`	`create(List<? extends T> plugins)` Deprecated. use `of(List)` instead.
`static <S,T extends Plugin<S>> SimplePluginRegistry<T,S>`	`empty()` Creates a new `SimplePluginRegistry`.
`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 registered plugins.
`List<T>`	`getPluginsFor(S delimiter)` Returns all plugins for the given delimiter.
`List<T>`	`getPluginsFor(S delimiter, List<? extends T> plugins)` Returns all `Plugin`s 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>> SimplePluginRegistry<T,S>`	`of(List<? extends T> plugins)` Creates a new `SimplePluginRegistry` with the given `Plugin` s.
`static <S,T extends Plugin<S>> SimplePluginRegistry<T,S>`	`of(T... plugins)` Creates a new `SimplePluginRegistry` with the given `Plugin` s.

Methods inherited from class org.springframework.plugin.core.PluginRegistrySupport
initialize, iterator

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.plugin.core.PluginRegistry
of, of

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - SimplePluginRegistry
```
protected SimplePluginRegistry(List<? extends T> plugins)
```
    Creates a new SimplePluginRegistry. Will create an empty registry if null is provided.
    
    Parameters:
    
    plugins - must not be null.
- Method Detail
  - empty
```
public static <S,T extends Plugin<S>> SimplePluginRegistry<T,S> empty()
```
    Creates a new SimplePluginRegistry.
    
    Returns:
  - of
```
@SafeVarargs
public static <S,T extends Plugin<S>> SimplePluginRegistry<T,S> of(T... plugins)
```
    Creates a new SimplePluginRegistry with the given Plugin s.
    
    Parameters:
    
    plugins - must not be null.
    
    Returns:
  - of
```
public static <S,T extends Plugin<S>> SimplePluginRegistry<T,S> of(List<? extends T> plugins)
```
    Creates a new SimplePluginRegistry with the given Plugin s.
    
    Parameters:
    
    plugins - must not be null.
    
    Returns:
  - create
```
@Deprecated
public static <S,T extends Plugin<S>> SimplePluginRegistry<T,S> create()
```
    Deprecated. use empty() instead.
    
    Creates a new SimplePluginRegistry.
    
    Returns:
  - create
```
@Deprecated
public static <S,T extends Plugin<S>> SimplePluginRegistry<T,S> create(List<? extends T> plugins)
```
    Deprecated. use of(List) instead.
    
    Creates a new SimplePluginRegistry with the given Plugin s.
    
    Returns:
  - getPlugins
```
public List<T> getPlugins()
```
    Description copied from class: PluginRegistrySupport
    
    Returns all registered plugins. Only use this method if you really need to access all plugins. For distinguished access to certain plugins favour accessor methods like {link #getPluginFor} over this one. This method should only be used for testing purposes to check registry configuration.
    
    Specified by:
    
    getPlugins in interface PluginRegistry<T extends Plugin<S>,S>
    
    Overrides:
    
    getPlugins in class PluginRegistrySupport<T extends Plugin<S>,S>
    
    Returns:
    
    all plugins of the registry
  - getPluginFor
```
public Optional<T> getPluginFor(S delimiter)
```
    Description copied from interface: PluginRegistry
    
    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
```
public T getRequiredPluginFor(S delimiter)
```
    Description copied from interface: PluginRegistry
    
    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.
  - getRequiredPluginFor
```
public T getRequiredPluginFor(S delimiter,
                              Supplier<String> message)
                       throws IllegalArgumentException
```
    Description copied from interface: PluginRegistry
    
    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
```
public List<T> getPluginsFor(S delimiter)
```
    Description copied from interface: PluginRegistry
    
    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
```
public <E extends Exception> T getPluginFor(S delimiter,
                                            Supplier<E> ex)
                                     throws E extends Exception
```
    Description copied from interface: PluginRegistry
    
    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
```
public <E extends Exception> List<T> getPluginsFor(S delimiter,
                                                   Supplier<E> ex)
                                            throws E extends Exception
```
    Description copied from interface: PluginRegistry
    
    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
```
public T getPluginOrDefaultFor(S delimiter,
                               T plugin)
```
    Description copied from interface: PluginRegistry
    
    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
```
public T getPluginOrDefaultFor(S delimiter,
                               Supplier<T> defaultSupplier)
```
    Description copied from interface: PluginRegistry
    
    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
```
public List<T> getPluginsFor(S delimiter,
                             List<? extends T> plugins)
```
    Description copied from interface: PluginRegistry
    
    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
```
public int countPlugins()
```
    Description copied from interface: PluginRegistry
    
    Returns the number of registered plugins.
    
    Returns:
    
    the number of plugins in the registry
  - contains
```
public boolean contains(T plugin)
```
    Description copied from interface: PluginRegistry
    
    Returns whether the registry contains a given plugin.
    
    Parameters:
    
    plugin - must not be null.
    
    Returns:
  - hasPluginFor
```
public boolean hasPluginFor(S delimiter)
```
    Description copied from interface: PluginRegistry
    
    Returns whether the registry contains a Plugin matching the given delimiter.
    
    Parameters:
    
    delimiter - must not be null.
    
    Returns:

Class SimplePluginRegistry<T extends Plugin<S>,S>

Constructor Summary

Method Summary

Methods inherited from class org.springframework.plugin.core.PluginRegistrySupport

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.plugin.core.PluginRegistry

Methods inherited from interface java.lang.Iterable

Constructor Detail

SimplePluginRegistry

Method Detail

empty

of

of

create

create

getPlugins

getPluginFor

getRequiredPluginFor

getRequiredPluginFor

getPluginsFor

getPluginFor

getPluginsFor

getPluginOrDefaultFor

getPluginOrDefaultFor

getPluginsFor

countPlugins

contains

hasPluginFor