Package hudson.cli

Class RunRangeCommand

java.lang.Object

hudson.cli.CLICommand

hudson.cli.RunRangeCommand

All Implemented Interfaces:

ExtensionPoint, Cloneable

Direct Known Subclasses:

DeleteBuildsCommand, ListChangesCommand

public abstract class RunRangeCommand
extends CLICommand

CLICommand that acts on a series of Runs.

Since:

2.62

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
Job<?,?>	job
String	range

Fields inherited from class hudson.cli.CLICommand

ALLOW_AT_SYNTAX, channel, locale, stderr, stdin, stdout

Constructor Summary

Constructors

Constructor	Description
RunRangeCommand()

Method Summary

Modifier and Type	Method	Description
protected abstract int	act(List<Run<?,?>> builds)
protected int	run()	Executes the command, and return the exit code.

Methods inherited from class hudson.cli.CLICommand

all, checkChannel, clone, createClone, getClientCharset, getClientEnvironmentVariable, getClientSystemProperty, getCmdLineParser, getCurrent, getLongDescription, getName, getShortDescription, getSingleLineSummary, getTransportAuthentication, getTransportAuthentication2, getUsage, main, printUsage, printUsageSummary, registerOptionHandlers, setClientCharset, setTransportAuth, setTransportAuth2

Methods inherited from class java.lang.Object

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

Field Details

job

public Job<?,?> job

range

public String range

Constructor Details

RunRangeCommand

public RunRangeCommand()

Method Details

run

protected int run()
           throws Exception

Description copied from class: CLICommand

Executes the command, and return the exit code.

This is an internal contract between CLICommand and its subtype. To execute CLI method from outside, use CLICommand.main(List, Locale, InputStream, PrintStream, PrintStream)

Specified by:

run in class CLICommand

Returns:

0 to indicate a success, otherwise a custom error code. Error codes 1-15 shouldn;t be used in CLICommand.run() as a custom error code.

Throws:

Exception - If a further unspecified exception is thrown; means: Unknown and/or unexpected issue occurred

org.kohsuke.args4j.CmdLineException - If a wrong parameter specified, input value can't be decoded etc.

IllegalArgumentException - If the execution can't continue due to wrong input parameter (job doesn't exist etc.)

IllegalStateException - If the execution can't continue due to an incorrect state of Jenkins, job, build etc.

AbortException - If the execution can't continue due to an other (rare, but foreseeable) issue

org.springframework.security.access.AccessDeniedException - If the caller doesn't have sufficient rights for requested action

org.springframework.security.authentication.BadCredentialsException - If bad credentials were provided to CLI

act

protected abstract int act(List<Run<?,?>> builds)
                    throws IOException

Throws:

IOException