com.cloudbees.hudson.plugins.folder

Class ItemDeletion

java.lang.Object

hudson.model.Queue.QueueDecisionHandler

com.cloudbees.hudson.plugins.folder.ItemDeletion

All Implemented Interfaces:

hudson.ExtensionPoint

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @Extension
public class ItemDeletion
extends hudson.model.Queue.QueueDecisionHandler

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

Since:

TODO

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
ItemDeletion()

Method Summary

Modifier and Type	Method and Description
static boolean	contains(hudson.model.Item item) Checks if the supplied Item or any of its Item.getParent() are being deleted.
static void	deregister(hudson.model.Item item) Deregister the supplied Item for deletion.
static hudson.model.Item	getItemOf(hudson.model.queue.SubTask t) Gets the Item most closely associated with the supplied SubTask.
static boolean	isRegistered(hudson.model.Item item) Checks if the supplied Item is explicitly registered for deletion.
static boolean	register(hudson.model.Item item) Register the supplied Item for deletion.
boolean	shouldSchedule(hudson.model.Queue.Task p, List<hudson.model.Action> actions)

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
                               hudson.model.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
                                   hudson.model.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
                               hudson.model.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
                              hudson.model.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(hudson.model.Queue.Task p,
                              List<hudson.model.Action> actions)

Specified by:

shouldSchedule in class hudson.model.Queue.QueueDecisionHandler

getItemOf

@CheckForNull
public static hudson.model.Item getItemOf(@Nonnull
                                                        hudson.model.queue.SubTask t)

Gets the Item most closely associated with the supplied SubTask.

Parameters:

t - the SubTask.

Returns:

the Item associated with the SubTask or null if this SubTask is not associated with an Item

Since:

TODO