Package jenkins.advancedqueue.sorter

Class SorterStrategy

java.lang.Object

jenkins.advancedqueue.sorter.SorterStrategy

All Implemented Interfaces:

ExtensionPoint, Describable<SorterStrategy>

Direct Known Subclasses:

MultiBucketStrategy

public abstract class SorterStrategy
extends Object
implements ExtensionPoint, Describable<SorterStrategy>

Since:

2.0

Author:

Magnus Sandberg

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
SorterStrategy()

Method Summary

Modifier and Type	Method	Description
static ExtensionList<SorterStrategy>	all()	All registered SorterStrategys.
static List<SorterStrategyDescriptor>	getAllSorterStrategies()
abstract int	getDefaultPriority()	Gets a default priority bucket to be used.
SorterStrategyDescriptor	getDescriptor()
abstract int	getNumberOfPriorities()	Gets number of priority buckets to be used.
static SorterStrategy	getPrioritySorterStrategy(SorterStrategyDescriptor sorterStrategy)
static SorterStrategyDescriptor	getSorterStrategy(String key)
void	onCanceledItem(Queue.LeftItem item)	Called when a Item leaves the queue and it is canceled.
abstract SorterStrategyCallback	onNewItem(Queue.Item item, SorterStrategyCallback weightCallback)	Called when a new Item enters the queue.
void	onStartedItem(Queue.LeftItem item, float weight)	Called when a Item leaves the queue and it is started.

Methods inherited from class java.lang.Object

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

Constructor Detail

SorterStrategy

public SorterStrategy()

Method Detail

getDescriptor

public SorterStrategyDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<SorterStrategy>

onNewItem

public abstract SorterStrategyCallback onNewItem(@NonNull
                                                 Queue.Item item,
                                                 SorterStrategyCallback weightCallback)

Called when a new Item enters the queue.

Parameters:

item - the Queue.WaitingItem or BuildableItem that enters the queue

weightCallback - the callback holds the priority to use anded the called method must set the weight before returning

Returns:

the SorterStrategyCallback provided to the call must be returned

onStartedItem

public void onStartedItem(@NonNull
                          Queue.LeftItem item,
                          float weight)

Called when a Item leaves the queue and it is started.

Parameters:

item - the Queue.LeftItem

weight - the weight assigned when the item entered the queue

onCanceledItem

public void onCanceledItem(@NonNull
                           Queue.LeftItem item)

Called when a Item leaves the queue and it is canceled.

getNumberOfPriorities

public abstract int getNumberOfPriorities()

Gets number of priority buckets to be used.

getDefaultPriority

public abstract int getDefaultPriority()

Gets a default priority bucket to be used.

getAllSorterStrategies

public static List<SorterStrategyDescriptor> getAllSorterStrategies()

getSorterStrategy

@CheckForNull
public static SorterStrategyDescriptor getSorterStrategy(String key)

getPrioritySorterStrategy

@CheckForNull
public static SorterStrategy getPrioritySorterStrategy(SorterStrategyDescriptor sorterStrategy)

all

public static ExtensionList<SorterStrategy> all()

All registered SorterStrategys.