Package net.shibboleth.metadata.pipeline

Class ItemOrderingStage<T>

java.lang.Object
net.shibboleth.shared.component.AbstractInitializableComponent
net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent
net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent
net.shibboleth.metadata.pipeline.AbstractStage<T>
net.shibboleth.metadata.pipeline.ItemOrderingStage<T>
Type Parameters:
T - type of the items to be ordered
All Implemented Interfaces:
Stage<T>, net.shibboleth.shared.component.Component, net.shibboleth.shared.component.DestructableComponent, net.shibboleth.shared.component.IdentifiableComponent, net.shibboleth.shared.component.IdentifiedComponent, net.shibboleth.shared.component.InitializableComponent
@ThreadSafe public class ItemOrderingStage<T> extends AbstractStage<T>
A Stage capable of ordering a collection of Items according to a supplied strategy.
Since:
0.10.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private ItemOrderingStrategy<T>
    orderingStrategy
    Strategy used to order a collection of Items.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ItemOrderingStage()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doExecute(List<Item<T>> items)
    Performs the stage processing on the given Item collection.
    final ItemOrderingStrategy<T>
    getItemOrderingStrategy()
    Gets the strategy used to order a collection of Items.
    void
    setItemOrderingStrategy(ItemOrderingStrategy<T> strategy)
    Sets the strategy used to order a collection of Items.

    Methods inherited from class net.shibboleth.metadata.pipeline.AbstractStage

    execute, getCollectionPredicate, setCollectionPredicate

    Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

    setId

    Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

    doInitialize, ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException

    Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

    checkComponentActive, checkSetterPreconditions, destroy, doDestroy, initialize, isDestroyed, isInitialized

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface net.shibboleth.shared.component.DestructableComponent

    destroy, isDestroyed

    Methods inherited from interface net.shibboleth.shared.component.IdentifiedComponent

    getId

    Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

    initialize, isInitialized

  • Field Details

    • orderingStrategy

      @Nonnull private ItemOrderingStrategy<T> orderingStrategy
      Strategy used to order a collection of Items. The default strategy performs no ordering.

  • Constructor Details

    • ItemOrderingStage

      public ItemOrderingStage()

  • Method Details

    • getItemOrderingStrategy

      @Nonnull public final ItemOrderingStrategy<T> getItemOrderingStrategy()
      Gets the strategy used to order a collection of Items.
      Returns:
      strategy used to order a collection of Items

    • setItemOrderingStrategy

      public void setItemOrderingStrategy(@Nonnull ItemOrderingStrategy<T> strategy)
      Sets the strategy used to order a collection of Items.
      Parameters:
      strategy - strategy used to order a collection of Items

    • doExecute

      protected void doExecute(@Nonnull @NonnullElements List<Item<T>> items) throws StageProcessingException
      Description copied from class: AbstractStage
      Performs the stage processing on the given Item collection.

      The stage is guaranteed to be have been initialized and not destroyed when this is invoked.

      Specified by:
      doExecute in class AbstractStage<T>
      Parameters:
      items - collection to be processed
      Throws:
      StageProcessingException - thrown if there is an unrecoverable problem when processing the stage