hudson.cli

Class CommandDuringBuild

java.lang.Object

hudson.cli.CLICommand

hudson.cli.CommandDuringBuild

All Implemented Interfaces:

ExtensionPoint, Cloneable

Direct Known Subclasses:

SetBuildParameterCommand, SetBuildResultCommand

public abstract class CommandDuringBuild
extends CLICommand

Base class for those commands that are valid only during a build.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.cli.CLICommand

channel, locale, stderr, stdin, stdout, TRANSPORT_AUTHENTICATION

Constructor Summary

Constructors

Constructor and Description
CommandDuringBuild()

Method Summary

Modifier and Type	Method and Description
protected Run	getCurrentlyBuilding() This method makes sense only when called from within the build kicked by Jenkins.
protected Run	optCurrentlyBuilding() If the command is currently running inside a build, return it.

Methods inherited from class hudson.cli.CLICommand

all, checkChannel, clone, createClone, getClientCharset, getClientEnvironmentVariable, getClientSystemProperty, getCmdLineParser, getCurrent, getLongDescription, getName, getShortDescription, getSingleLineSummary, getTransportAuthentication, getUsage, loadStoredAuthentication, main, printUsage, printUsageSummary, registerOptionHandlers, run, setTransportAuth, shouldPerformAuthentication

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandDuringBuild

public CommandDuringBuild()

Method Detail

getCurrentlyBuilding

protected Run getCurrentlyBuilding()
                            throws org.kohsuke.args4j.CmdLineException

This method makes sense only when called from within the build kicked by Jenkins. We use the environment variables that Jenkins sets to determine the build that is being run.

Throws:

org.kohsuke.args4j.CmdLineException

optCurrentlyBuilding

protected Run optCurrentlyBuilding()
                            throws org.kohsuke.args4j.CmdLineException

If the command is currently running inside a build, return it. Otherwise null.

Throws:

org.kohsuke.args4j.CmdLineException