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:

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.

Author:

Oliver Gierke

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OrderAwarePluginRegistry(List<? extends T> plugins, 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() Deprecated. since 2.0, for removal in 2.1. Prefer PluginRegistry.empty().
static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S>	create(Comparator<? super T> comparator) Deprecated. since 2.0, for removal in 2.1. Prefer PluginRegistry.of(Comparator).
static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S>	create(List<? extends T> plugins) Deprecated. since 2.0, for removal in 2.1. Prefer PluginRegistry.of(List).
static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S>	create(List<? extends T> plugins, Comparator<? super T> comparator) Deprecated. since 2.0, for removal in 2.1. Prefer PluginRegistry.of(List, Comparator).
static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S>	createReverse(List<? extends T> plugins) Deprecated. since 2.0, for removal in 2.1. Prefer ofReverse(List)
static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S>	empty() Creates a new OrderAwarePluginRegistry using the #DEFAULT_COMPARATOR.
protected List<T>	initialize(List<T> plugins) Callback to initialize the plugin List.
static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S>	of(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>	of(List<? extends T> plugins) Creates a new OrderAwarePluginRegistry with the given plugins.
static <S,T extends Plugin<S>> OrderAwarePluginRegistry<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>> OrderAwarePluginRegistry<T,S>	of(T... plugins) Creates a new OrderAwarePluginRegistry with the given plugins.
static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S>	ofReverse(List<? extends T> plugins) Creates a new OrderAwarePluginRegistry with the given Plugins and the order of the Plugins reverted.
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, getPluginOrDefaultFor, getPluginOrDefaultFor, getPlugins, getPluginsFor, getPluginsFor, getPluginsFor, getRequiredPluginFor, getRequiredPluginFor, 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

Constructor Detail

OrderAwarePluginRegistry

protected OrderAwarePluginRegistry(List<? extends T> plugins,
                                   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

empty

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

Creates a new OrderAwarePluginRegistry using the #DEFAULT_COMPARATOR.

Returns:

Since:

2.0

of

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

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

Parameters:

comparator - must not be null.

Returns:

Since:

2.0

of

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

Creates a new OrderAwarePluginRegistry with the given plugins.

Parameters:

plugins - must not be null.

Returns:

Since:

2.0

of

public static <S,T extends Plugin<S>> OrderAwarePluginRegistry<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

ofReverse

public static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S> ofReverse(List<? extends T> plugins)

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

Parameters:

plugins - must not be null.

Returns:

Since:

2.0

of

public static <S,T extends Plugin<S>> OrderAwarePluginRegistry<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

create

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

Deprecated. since 2.0, for removal in 2.1. Prefer PluginRegistry.empty().

Creates a new OrderAwarePluginRegistry using the #DEFAULT_COMPARATOR.

Returns:

create

@Deprecated
public static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S> create(Comparator<? super T> comparator)

Deprecated. since 2.0, for removal in 2.1. Prefer PluginRegistry.of(Comparator).

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

Parameters:

comparator - must not be null.

Returns:

create

@Deprecated
public static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S> create(List<? extends T> plugins)

Deprecated. since 2.0, for removal in 2.1. Prefer PluginRegistry.of(List).

Creates a new OrderAwarePluginRegistry with the given plugins.

Parameters:

plugins - must not be null.

Returns:

createReverse

@Deprecated
public static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S> createReverse(List<? extends T> plugins)

Deprecated. since 2.0, for removal in 2.1. Prefer ofReverse(List)

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

Parameters:

plugins - must not be null.

Returns:

create

@Deprecated
public static <S,T extends Plugin<S>> OrderAwarePluginRegistry<T,S> create(List<? extends T> plugins,
                                                                                       Comparator<? super T> comparator)

Deprecated. since 2.0, for removal in 2.1. Prefer PluginRegistry.of(List, Comparator).

Creates a new OrderAwarePluginRegistry with the given plugins.

Parameters:

plugins - must not be null.

Returns:

initialize

protected List<T> initialize(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: