Package net.shibboleth.metadata.pipeline

Interface ItemOrderingStrategy<T>

Type Parameters:

T - type of item to be handled

All Known Implementing Classes:

NoOpItemOrderingStrategy

@ThreadSafe
public interface ItemOrderingStrategy<T>

A strategy that defines how to order a Item collection.

All implementations of this interface must be thread-safe.

Since:

0.10.0

Method Summary

Modifier and Type	Method	Description
List<Item<T>>	order(List<Item<T>> items)	Orders a given Item collection.

Method Details

order

@Nonnull
@NonnullElements
@Unmodifiable
List<Item<T>> order(@Nonnull @NonnullElements @Unmodifiable
 List<Item<T>> items)
             throws StageProcessingException

Orders a given Item collection.

Parameters:

items - collection of Items, never null

Returns:

sorted List of Items, never null

Throws:

StageProcessingException - if the items in the collection cannot be ordered, for example because they do not meet required pre-conditions