Package jenkins.advancedqueue.priority

Class PriorityStrategy

java.lang.Object

jenkins.advancedqueue.priority.PriorityStrategy

All Implemented Interfaces:

ExtensionPoint, Describable<PriorityStrategy>

Direct Known Subclasses:

AbstractDynamicPriorityStrategy, AbstractStaticPriorityStrategy, JobGroup.PriorityStrategyHolder

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

Since:

2.0

Author:

Magnus Sandberg

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
PriorityStrategy()

Method Summary

Modifier and Type	Method	Description
static DescriptorExtensionList<PriorityStrategy,Descriptor<PriorityStrategy>>	all()
abstract int	getPriority(Queue.Item item)	Method that that return the priority that should be used for this Queue.Item, this method is only called id isApplicable(Queue.Item) returned true The caller garanties that the Queue.Item.task is a Job
abstract boolean	isApplicable(Queue.Item item)	Method that checks if strategy can assign a priority to the provided Queue.Item The caller guaranties that the Queue.Item.task is a Job
abstract void	numberPrioritiesUpdates(int oldNumberOfPriorities, int newNumberOfPriorities)

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Describable

getDescriptor

Constructor Details

PriorityStrategy

public PriorityStrategy()

Method Details

isApplicable

public abstract boolean isApplicable(Queue.Item item)

Method that checks if strategy can assign a priority to the provided Queue.Item The caller guaranties that the Queue.Item.task is a Job

Parameters:

item - the Queue.Item to check

Returns:

true if the PriorityStrategy is applicable else false

getPriority

public abstract int getPriority(Queue.Item item)

Method that that return the priority that should be used for this Queue.Item, this method is only called id isApplicable(Queue.Item) returned true The caller garanties that the Queue.Item.task is a Job

Parameters:

item - the Queue.Item to check

Returns:

the priority to be used by the provided Queue.Item

numberPrioritiesUpdates

public abstract void numberPrioritiesUpdates(int oldNumberOfPriorities,
 int newNumberOfPriorities)

all

public static DescriptorExtensionList<PriorityStrategy,Descriptor<PriorityStrategy>> all()