org.jenkinsci.plugins.gitclient

Class UnsupportedCommand

java.lang.Object

org.jenkinsci.plugins.gitclient.UnsupportedCommand

public class UnsupportedCommand
extends Object

A command to convey unsupported features. Currently, implemented for JGit. All of the operations listed below are not implemented in JGit currently.

Constructor Summary

Constructors

Constructor and Description
UnsupportedCommand()

Method Summary

Modifier and Type	Method and Description
UnsupportedCommand	depth(Integer depth) JGit is unsupported if depth is non-null.
boolean	determineSupportForJGit() Returns true if JGit is supported based on previously passed values.
UnsupportedCommand	firstParent(boolean firstParent) JGit is unsupported if firstParent is true.
UnsupportedCommand	gitPublisher(boolean isEnabled) JGit doesn't support Git Publisher.
UnsupportedCommand	lfsCredentials(com.cloudbees.plugins.credentials.common.StandardCredentials lfsCredentials) JGit is unsupported if lfsCredentials is non-null.
UnsupportedCommand	lfsRemote(String lfsRemote) JGit is unsupported if lfsRemote is non-null.
UnsupportedCommand	parentCredentials(boolean parentCredentials) JGit is unsupported if parentCredentials is true.
UnsupportedCommand	ref(String ref) JGit is unsupported if ref is non-empty.
UnsupportedCommand	remoteTracking(boolean remoteTracking) JGit is unsupported if remoteTracking is true.
UnsupportedCommand	shallow(boolean shallow) JGit is unsupported if shallow is true.
UnsupportedCommand	sparseCheckoutPaths(List<String> sparseCheckoutPaths) JGit is unsupported if sparseCheckoutPaths is non-empty.
UnsupportedCommand	threads(Integer threads) JGit is unsupported if threads is non-zero.
UnsupportedCommand	timeout(Integer timeout) JGit is unsupported if timeout is non-null.
UnsupportedCommand	useBranch(String submodule, String branchname) JGit is unsupported if submodule or branchName are non-null.

Methods inherited from class java.lang.Object

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

Constructor Detail

UnsupportedCommand

public UnsupportedCommand()

Method Detail

sparseCheckoutPaths

public UnsupportedCommand sparseCheckoutPaths(List<String> sparseCheckoutPaths)

JGit is unsupported if sparseCheckoutPaths is non-empty.

Parameters:

sparseCheckoutPaths - list of paths to be included in the checkout

Returns:

this for chaining

timeout

public UnsupportedCommand timeout(Integer timeout)

JGit is unsupported if timeout is non-null. Could be supported if timeout is 0, since that means no timeout.

Parameters:

timeout - maximum time git operation is allowed before it is interrupted

Returns:

this for chaining

lfsRemote

public UnsupportedCommand lfsRemote(String lfsRemote)

JGit is unsupported if lfsRemote is non-null.

Parameters:

lfsRemote - URL of large file support server

Returns:

this for chaining

lfsCredentials

public UnsupportedCommand lfsCredentials(com.cloudbees.plugins.credentials.common.StandardCredentials lfsCredentials)

JGit is unsupported if lfsCredentials is non-null.

Parameters:

lfsCredentials - credential used for large file support

Returns:

this for chaining

shallow

public UnsupportedCommand shallow(boolean shallow)

JGit is unsupported if shallow is true.

Parameters:

shallow - if true then shallow clone and fetch are enabled

Returns:

this for chaining

depth

public UnsupportedCommand depth(Integer depth)

JGit is unsupported if depth is non-null. Could also be supported if depth is 0, since that means unlimited depth.

Parameters:

depth - depth of commits to be fetched into workspace

Returns:

this for chaining

firstParent

public UnsupportedCommand firstParent(boolean firstParent)

JGit is unsupported if firstParent is true.

Parameters:

firstParent - if true, only consider the first parents of a merge in revision list

Returns:

this for chaining

threads

public UnsupportedCommand threads(Integer threads)

JGit is unsupported if threads is non-zero.

Parameters:

threads - count of threads to use for parallel submodule update

Returns:

this for chaining

remoteTracking

public UnsupportedCommand remoteTracking(boolean remoteTracking)

JGit is unsupported if remoteTracking is true.

Parameters:

remoteTracking - submodule should use a remote tracking branch if true

Returns:

this for chaining

ref

public UnsupportedCommand ref(String ref)

JGit is unsupported if ref is non-empty.

Parameters:

ref - location of submodule reference repository

Returns:

this for chaining

parentCredentials

public UnsupportedCommand parentCredentials(boolean parentCredentials)

JGit is unsupported if parentCredentials is true.

Parameters:

parentCredentials - submodule update uses credentials from parent repository if true

Returns:

this for chaining

useBranch

public UnsupportedCommand useBranch(String submodule,
                                    String branchname)

JGit is unsupported if submodule or branchName are non-null.

Parameters:

submodule - name of submodule that should checkout a specific branch

branchname - name of branch to be checked out for submodule

Returns:

this for chaining

gitPublisher

public UnsupportedCommand gitPublisher(boolean isEnabled)

JGit doesn't support Git Publisher.

Parameters:

isEnabled - if true, then git publisher post-build action is enabled in this context

Returns:

this for chaining

determineSupportForJGit

public boolean determineSupportForJGit()

Returns true if JGit is supported based on previously passed values.

Returns:

true if JGit is supported based on previously passed values