hudson.plugins.git.extensions.impl

Class CheckoutOption

java.lang.Object

hudson.model.AbstractDescribableImpl<GitSCMExtension>

hudson.plugins.git.extensions.GitSCMExtension

hudson.plugins.git.extensions.FakeGitSCMExtension

hudson.plugins.git.extensions.impl.CheckoutOption

All Implemented Interfaces:

Describable<GitSCMExtension>

public class CheckoutOption
extends FakeGitSCMExtension

Add options to the checkout command.

Author:

Mark Waite

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CheckoutOption.DescriptorImpl

Constructor Summary

Constructors

Constructor and Description
CheckoutOption(Integer timeout)

Method Summary

Modifier and Type	Method and Description
void	decorateCheckoutCommand(GitSCM scm, AbstractBuild<?,?> build, org.jenkinsci.plugins.gitclient.GitClient git, BuildListener listener, org.jenkinsci.plugins.gitclient.CheckoutCommand cmd) Deprecated.
void	decorateCheckoutCommand(GitSCM scm, Run<?,?> build, org.jenkinsci.plugins.gitclient.GitClient git, TaskListener listener, org.jenkinsci.plugins.gitclient.CheckoutCommand cmd) Called before a CheckoutCommand is executed to allow extensions to alter its behaviour.
void	determineSupportForJGit(GitSCM scm, org.jenkinsci.plugins.gitclient.UnsupportedCommand cmd) Called when support of JGit for a particular or multiple extensions is to be determined
boolean	equals(Object o)
Integer	getTimeout()
int	hashCode()
boolean	requiresWorkspaceForPolling()
String	toString()

Methods inherited from class hudson.plugins.git.extensions.GitSCMExtension

beforeCheckout, beforeCheckout, decorate, decorateCloneCommand, decorateCloneCommand, decorateFetchCommand, decorateFetchCommand, decorateMergeCommand, decorateMergeCommand, decorateRevisionToBuild, decorateRevisionToBuild, enableMultipleRevisionDetection, getDescriptor, getRequiredClient, getWorkingDirectory, getWorkingDirectory, isRevExcluded, onCheckoutCompleted, onCheckoutCompleted, onClean, populateEnvironmentVariables

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CheckoutOption

@DataBoundConstructor
public CheckoutOption(Integer timeout)

Method Detail

getTimeout

public Integer getTimeout()

requiresWorkspaceForPolling

public boolean requiresWorkspaceForPolling()

Overrides:

requiresWorkspaceForPolling in class GitSCMExtension

Returns:

true when this extension has a requirement to get a workspace during polling, typically as it has to check for incoming changes, not just remote HEAD.

decorateCheckoutCommand

public void decorateCheckoutCommand(GitSCM scm,
                                    Run<?,?> build,
                                    org.jenkinsci.plugins.gitclient.GitClient git,
                                    TaskListener listener,
                                    org.jenkinsci.plugins.gitclient.CheckoutCommand cmd)
                             throws IOException,
                                    InterruptedException,
                                    hudson.plugins.git.GitException

Called before a CheckoutCommand is executed to allow extensions to alter its behaviour.

Overrides:

decorateCheckoutCommand in class GitSCMExtension

Parameters:

scm - GitSCM object

build - run context

git - GitClient

listener - build log

cmd - checkout command to be decorated

Throws:

IOException - on input or output error

InterruptedException - when interrupted

hudson.plugins.git.GitException - on git error

determineSupportForJGit

public void determineSupportForJGit(GitSCM scm,
                                    @NonNull
                                    org.jenkinsci.plugins.gitclient.UnsupportedCommand cmd)

Description copied from class: GitSCMExtension

Called when support of JGit for a particular or multiple extensions is to be determined

Overrides:

determineSupportForJGit in class GitSCMExtension

Parameters:

scm - GitSCM object

cmd - UnsupportedCommand object

decorateCheckoutCommand

@Deprecated
public void decorateCheckoutCommand(GitSCM scm,
                                                AbstractBuild<?,?> build,
                                                org.jenkinsci.plugins.gitclient.GitClient git,
                                                BuildListener listener,
                                                org.jenkinsci.plugins.gitclient.CheckoutCommand cmd)
                                         throws IOException,
                                                InterruptedException,
                                                hudson.plugins.git.GitException

Deprecated.

Overrides:

decorateCheckoutCommand in class GitSCMExtension

Throws:

IOException

InterruptedException

hudson.plugins.git.GitException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object