jenkins.model.queue

Class ItemDeletion

java.lang.Object

hudson.model.Queue.QueueDecisionHandler

jenkins.model.queue.ItemDeletion

All Implemented Interfaces:

ExtensionPoint

@Extension
public class ItemDeletion
extends Queue.QueueDecisionHandler

A Queue.QueueDecisionHandler that blocks items being deleted from entering the queue.

Since:

2.55

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
ItemDeletion()

Method Summary

Modifier and Type	Method and Description
static boolean	contains(Item item) Checks if the supplied Item or any of its Item.getParent() are being deleted.
static void	deregister(Item item) Deregister the supplied Item for deletion.
static boolean	isRegistered(Item item) Checks if the supplied Item is explicitly registered for deletion.
static boolean	register(Item item) Register the supplied Item for deletion.
boolean	shouldSchedule(Queue.Task p, List<Action> actions) Returns whether the new item should be scheduled.

Methods inherited from class hudson.model.Queue.QueueDecisionHandler

all

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemDeletion

public ItemDeletion()

Method Detail

contains

public static boolean contains(@NonNull
                               Item item)

Checks if the supplied Item or any of its Item.getParent() are being deleted.

Parameters:

item - the item.

Returns:

true if the Item or any of its Item.getParent() are being deleted.

isRegistered

public static boolean isRegistered(@NonNull
                                   Item item)

Checks if the supplied Item is explicitly registered for deletion.

Parameters:

item - the item.

Returns:

true if and only if the supplied Item has been register(Item)ed for deletion.

register

public static boolean register(@NonNull
                               Item item)

Register the supplied Item for deletion.

Parameters:

item - the Item that is to be deleted.

Returns:

true if and only if the Item was registered and the caller is now responsible to call deregister(Item).

deregister

public static void deregister(@NonNull
                              Item item)

Deregister the supplied Item for deletion.

Parameters:

item - the Item that was to be deleted and is now either deleted or the delete was aborted.

shouldSchedule

public boolean shouldSchedule(Queue.Task p,
                              List<Action> actions)

Description copied from class: Queue.QueueDecisionHandler

Returns whether the new item should be scheduled.

Specified by:

shouldSchedule in class Queue.QueueDecisionHandler

actions - List of actions that are to be made available as Actionable.getActions() upon the start of the build. This list is live, and can be mutated.