org.springframework.plugin.core

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

java.lang.Object

org.springframework.plugin.core.PluginRegistrySupport<T,S>

org.springframework.plugin.core.SimplePluginRegistry<T,S>

org.springframework.plugin.core.OrderAwarePluginRegistry<T,S>

All Implemented Interfaces:

java.lang.Iterable<T>, PluginRegistry<T,S>

public class OrderAwarePluginRegistry<T extends Plugin<S>,S>
extends SimplePluginRegistry<T,S>

PluginRegistry implementation that be made aware of a certain ordering of Plugins. By default it orders Plugins by regarding Ordered interface or Order annotation. To alter ordering behaviour use one of the factory methods accepting a Comparator as parameter.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Comparator<? super T>	comparator
private static java.util.Comparator<java.lang.Object>	DEFAULT_COMPARATOR Comparator regarding Ordered interface or Order annotation.
private static java.util.Comparator<java.lang.Object>	DEFAULT_REVERSE_COMPARATOR Comparator reverting the .

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OrderAwarePluginRegistry(java.util.List<? extends T> plugins, java.util.Comparator<? super T> comparator) Creates a new OrderAwarePluginRegistry with the given Plugins and Comparator.

Method Summary

Modifier and Type	Method and Description
static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S>	create() Creates a new OrderAwarePluginRegistry using the #DEFAULT_COMPARATOR.
static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S>	create(java.util.Comparator<? super T> comparator) Creates a new OrderAwarePluginRegistry using the given Comparator for ordering contained Plugins.
static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S>	create(java.util.List<? extends T> plugins) Creates a new OrderAwarePluginRegistry with the given plugins.
static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S>	create(java.util.List<? extends T> plugins, java.util.Comparator<? super T> comparator) Creates a new OrderAwarePluginRegistry with the given plugins.
static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S>	createReverse(java.util.List<? extends T> plugins) Creates a new OrderAwarePluginRegistry with the given plugins and the order of the plugins reverted.
protected java.util.List<T>	initialize(java.util.List<T> plugins) Callback to initialize the plugin List.
OrderAwarePluginRegistry<T,S>	reverse() Returns a new OrderAwarePluginRegistry with the order of the plugins reverted.

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

contains, countPlugins, getPluginFor, getPluginFor, getPluginFor, getPlugins, getPluginsFor, getPluginsFor, getPluginsFor, hasPluginFor

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

iterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DEFAULT_COMPARATOR

private static final java.util.Comparator<java.lang.Object> DEFAULT_COMPARATOR

Comparator regarding Ordered interface or Order annotation.

DEFAULT_REVERSE_COMPARATOR

private static final java.util.Comparator<java.lang.Object> DEFAULT_REVERSE_COMPARATOR

Comparator reverting the .

comparator

private java.util.Comparator<? super T extends Plugin<S>> comparator

Constructor Detail

OrderAwarePluginRegistry

protected OrderAwarePluginRegistry(java.util.List<? extends T> plugins,
                                   java.util.Comparator<? super T> comparator)

Creates a new OrderAwarePluginRegistry with the given Plugins and Comparator.

Parameters:

plugins - the Plugins to be contained in the registry or null if the registry shall be empty initally.

comparator - the Comparator to be used for ordering the Plugins or null if the #DEFAULT_COMPARATOR shall be used.

Method Detail

create

public static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S> create()

Creates a new OrderAwarePluginRegistry using the #DEFAULT_COMPARATOR.

Type Parameters:

T -

S -

Returns:

create

public static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S> create(java.util.Comparator<? super T> comparator)

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

Type Parameters:

T -

S -

Returns:

create

public static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S> create(java.util.List<? extends T> plugins)

Creates a new OrderAwarePluginRegistry with the given plugins.

Type Parameters:

S -

T -

Parameters:

plugins -

Returns:

createReverse

public static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S> createReverse(java.util.List<? extends T> plugins)

Creates a new OrderAwarePluginRegistry with the given plugins and the order of the plugins reverted.

Type Parameters:

S -

T -

Parameters:

plugins -

Returns:

create

public static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S> create(java.util.List<? extends T> plugins,
                                                                           java.util.Comparator<? super T> comparator)

Creates a new OrderAwarePluginRegistry with the given plugins.

Type Parameters:

S -

T -

Parameters:

plugins -

Returns:

initialize

protected java.util.List<T> initialize(java.util.List<T> plugins)

Description copied from class: PluginRegistrySupport

Callback to initialize the plugin List. Will create a defensive copy of the List to potentially unwrap a List proxy. Will filter null values from the source list as well.

Overrides:

initialize in class PluginRegistrySupport<T extends Plugin<S>,S>

Parameters:

plugins - must not be null.

Returns:

reverse

public OrderAwarePluginRegistry<T,S> reverse()

Returns a new OrderAwarePluginRegistry with the order of the plugins reverted.

Returns: