Package hudson.cli
Class VersionCommand
- java.lang.Object
-
- hudson.cli.CLICommand
-
- hudson.cli.VersionCommand
-
- All Implemented Interfaces:
ExtensionPoint
,Cloneable
@Extension public class VersionCommand extends CLICommand
Retrieves the current version.- Author:
- Kohsuke Kawaguchi
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description VersionCommand()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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, getCmdLineParser, getCurrent, getLongDescription, getName, getSingleLineSummary, getTransportAuthentication, getTransportAuthentication2, getUsage, main, printUsage, printUsageSummary, registerOptionHandlers, setClientCharset, setTransportAuth, setTransportAuth2
-
-
-
-
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 classCLICommand
-
run
protected int run()
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, useCLICommand.main(List, Locale, InputStream, PrintStream, PrintStream)
- Specified by:
run
in classCLICommand
- 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.
-
-