hudson.cli
Class ListJobsCommand

java.lang.Object
  hudson.cli.CLICommand
      hudson.cli.ListJobsCommand

All Implemented Interfaces:

ExtensionPoint, Cloneable

@Extension
public class ListJobsCommand
extends CLICommand

Lists all jobs (in a specific view).

Author:

Michael Koch

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

String

name

Fields inherited from class hudson.cli.CLICommand

channel, locale, stderr, stdin, stdout, TRANSPORT_AUTHENTICATION

Constructor Summary

ListJobsCommand()

Method Summary

String	getShortDescription() Gets the quick summary of what this command does.
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, getCurrent, getName, getTransportAuthentication, loadStoredAuthentication, main, printUsage, printUsageSummary, registerOptionHandlers, setTransportAuth, shouldPerformAuthentication

Methods inherited from class java.lang.Object

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

Field Detail

name

public String name

Constructor Detail

ListJobsCommand

public ListJobsCommand()

Method Detail

getShortDescription

public String getShortDescription()

Description copied from class: CLICommand

Gets the quick summary of what this command does. Used by the help command to generate the list of commands.

Specified by:

getShortDescription in class CLICommand

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 an error code.

Throws:

AbortException - If the processing should be aborted. Hudson will report the error message without stack trace, and then exits this command.

Exception - All the other exceptions cause the stack trace to be dumped, and then the command exits with an error code.