Package com.cloudbees.hudson.plugins.folder.computed

Class OrphanedItemStrategy

java.lang.Object

hudson.model.AbstractDescribableImpl<OrphanedItemStrategy>

com.cloudbees.hudson.plugins.folder.computed.OrphanedItemStrategy

All Implemented Interfaces:

ExtensionPoint, Describable<OrphanedItemStrategy>

Direct Known Subclasses:

DefaultOrphanedItemStrategy

public abstract class OrphanedItemStrategy
extends AbstractDescribableImpl<OrphanedItemStrategy>
implements ExtensionPoint

A strategy for removing children after they are no longer indexed by an owning ComputedFolder.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
OrphanedItemStrategy()

Method Summary

Modifier and Type	Method	Description
OrphanedItemStrategyDescriptor	getDescriptor()
abstract <I extends TopLevelItem> Collection<I>	orphanedItems(ComputedFolder<I> owner, Collection<I> orphaned, TaskListener listener)	parameters and return value as in ComputedFolder.orphanedItems(java.util.Collection<I>, hudson.model.TaskListener)

Methods inherited from class java.lang.Object

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

Constructor Details

OrphanedItemStrategy

public OrphanedItemStrategy()

Method Details

orphanedItems

public abstract <I extends TopLevelItem>
Collection<I> orphanedItems(ComputedFolder<I> owner,
 Collection<I> orphaned,
 TaskListener listener)
                     throws IOException,
InterruptedException

parameters and return value as in ComputedFolder.orphanedItems(java.util.Collection<I>, hudson.model.TaskListener)

Type Parameters:

I - the type of item.

Parameters:

owner - the owning folder.

orphaned - a nonempty set of items which no longer are supposed to be here

listener - the listener to report decisions to.

Returns:

any subset of orphaned, representing those children which ought to be removed from the folder now; items not listed will be left alone for the time

Throws:

IOException - if there was an I/O issue processing the items.

InterruptedException - if interrupted while processing the items.

getDescriptor

public OrphanedItemStrategyDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<OrphanedItemStrategy>

Overrides:

getDescriptor in class AbstractDescribableImpl<OrphanedItemStrategy>