com.cloudbees.hudson.plugins.folder.computed

Class DefaultOrphanedItemStrategy

java.lang.Object

hudson.model.AbstractDescribableImpl<OrphanedItemStrategy>

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

com.cloudbees.hudson.plugins.folder.computed.DefaultOrphanedItemStrategy

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<OrphanedItemStrategy>

public class DefaultOrphanedItemStrategy
extends OrphanedItemStrategy

The default OrphanedItemStrategy. Trims dead items by the # of days or the # of builds much like LogRotator.

Author:

Stephen Connolly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultOrphanedItemStrategy.DescriptorImpl Our Descriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
DefaultOrphanedItemStrategy(boolean pruneDeadBranches, String daysToKeepStr, String numToKeepStr) Stapler's constructor.

Method Summary

Modifier and Type	Method and Description
int	getDaysToKeep() Gets the number of days to keep dead branches.
String	getDaysToKeepStr() Returns the number of days to keep dead branches.
int	getNumToKeep() Gets the number of dead branches to keep.
String	getNumToKeepStr() Gets the number of dead branches to keep.
boolean	isPruneDeadBranches() Returns true if dead branches should be removed.
<I extends hudson.model.TopLevelItem> Collection<I>	orphanedItems(ComputedFolder<I> owner, Collection<I> orphaned, hudson.model.TaskListener listener) parameters and return value as in ComputedFolder.orphanedItems(java.util.Collection<I>, hudson.model.TaskListener)

Methods inherited from class com.cloudbees.hudson.plugins.folder.computed.OrphanedItemStrategy

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultOrphanedItemStrategy

@DataBoundConstructor
public DefaultOrphanedItemStrategy(boolean pruneDeadBranches,
                                                         @CheckForNull
                                                         String daysToKeepStr,
                                                         @CheckForNull
                                                         String numToKeepStr)

Stapler's constructor.

Parameters:

pruneDeadBranches - remove dead branches.

daysToKeepStr - how old a branch must be to remove.

numToKeepStr - how many branches to keep.

Method Detail

getDaysToKeep

public int getDaysToKeep()

Gets the number of days to keep dead branches.

Returns:

the number of days to keep dead branches.

getNumToKeep

public int getNumToKeep()

Gets the number of dead branches to keep.

Returns:

the number of dead branches to keep.

isPruneDeadBranches

public boolean isPruneDeadBranches()

Returns true if dead branches should be removed.

Returns:

true if dead branches should be removed.

getDaysToKeepStr

@NonNull
public String getDaysToKeepStr()

Returns the number of days to keep dead branches.

Returns:

the number of days to keep dead branches.

getNumToKeepStr

@NonNull
public String getNumToKeepStr()

Gets the number of dead branches to keep.

Returns:

the number of dead branches to keep.

orphanedItems

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

Description copied from class: OrphanedItemStrategy

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

Specified by:

orphanedItems in class OrphanedItemStrategy

Throws:

IOException

InterruptedException