jenkins.branch

Class DefaultDeadBranchStrategy

java.lang.Object

hudson.model.AbstractDescribableImpl<DeadBranchStrategy>

jenkins.branch.DeadBranchStrategy

jenkins.branch.DefaultDeadBranchStrategy

All Implemented Interfaces:

hudson.model.Describable<DeadBranchStrategy>

public class DefaultDeadBranchStrategy
extends DeadBranchStrategy

The default DeadBranchStrategy.

Author:

Stephen Connolly

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
DefaultDeadBranchStrategy() Default constructor for new MultiBranchProject instances.
DefaultDeadBranchStrategy(boolean pruneDeadBranches, String daysToKeepStr, String numToKeepStr) Stapler's constructor.

Method Summary

Methods

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.
<P extends hudson.model.AbstractProject<P,R> & hudson.model.TopLevelItem,R extends hudson.model.AbstractBuild<P,R>> void	runDeadBranchCleanup(hudson.model.TaskListener listener, Map<String,P> deadBranches)
void	setOwner(MultiBranchProject<?,?> owner) Called by MultiBranchProject to set the owner once the source is attached to the project.

Methods inherited from class jenkins.branch.DeadBranchStrategy

getDescriptor, getOwner

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDeadBranchStrategy

public DefaultDeadBranchStrategy()

Default constructor for new MultiBranchProject instances.

DefaultDeadBranchStrategy

@DataBoundConstructor
public DefaultDeadBranchStrategy(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

setOwner

public void setOwner(MultiBranchProject<?,?> owner)

Called by MultiBranchProject to set the owner once the source is attached to the project.

Overrides:

setOwner in class DeadBranchStrategy

Parameters:

owner - the owner.

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.

runDeadBranchCleanup

public <P extends hudson.model.AbstractProject<P,R> & hudson.model.TopLevelItem,R extends hudson.model.AbstractBuild<P,R>> void runDeadBranchCleanup(hudson.model.TaskListener listener,
                                                                                                                                           Map<String,P> deadBranches)
                          throws IOException,
                                 InterruptedException

Specified by:

runDeadBranchCleanup in class DeadBranchStrategy

Throws:

IOException

InterruptedException