com.atlassian.bitbucket.scm

Class PushCommandParameters

java.lang.Object

com.atlassian.bitbucket.scm.PushCommandParameters

public class PushCommandParameters
extends Object

Since:

7.11

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PushCommandParameters.Builder

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Map<String,String>	getEnvironment()
Optional<String>	getPassword()
Optional<File>	getPrivateKey()
Set<String>	getRefspecs()
String	getRemoteUrl()
Optional<String>	getUsername()
int	hashCode()
boolean	isAnonymous()
boolean	isForce()
boolean	isIncludePrivateRefs() If an explicit refspec is set then this setting is ignored.
boolean	isPrune()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getEnvironment

@Nonnull
public Map<String,String> getEnvironment()

Returns:

a map of environment variables that will be applied to the push command

getPassword

@Nonnull
public Optional<String> getPassword()

Returns:

the password to provide for authentication

getPrivateKey

@Nonnull
public Optional<File> getPrivateKey()

Returns:

the SSH private key to use for authentication

getRefspecs

@Nonnull
public Set<String> getRefspecs()

Returns:

a set of refspecs to be passed to the push command, returns an empty set if not set

getRemoteUrl

@Nonnull
public String getRemoteUrl()

Returns:

the URL to push to

getUsername

@Nonnull
public Optional<String> getUsername()

Returns:

the username to provide for authentication

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isAnonymous

public boolean isAnonymous()

Returns:

whether the push command can be done in an anonymous context or not. If not provided, defaults to false

isForce

public boolean isForce()

Returns:

true when remote refs should be forced to update, false otherwise. If not provided, defaults to false

isIncludePrivateRefs

public boolean isIncludePrivateRefs()

If an explicit refspec is set then this setting is ignored.

Returns:

true if private refs (outside refs/heads and refs/tags) should be included in the push

isPrune

public boolean isPrune()

Returns:

true when remote branches and tags should be deleted where the local branch or tag has been deleted. If not provided, defaults to false

toString

public String toString()

Overrides:

toString in class Object