com.atlassian.bitbucket.scm

Class PatchCommandParameters

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

com.atlassian.bitbucket.scm.AbstractCommandParameters

com.atlassian.bitbucket.scm.PatchCommandParameters

public class PatchCommandParameters
extends AbstractCommandParameters

Describes a commit for which to generate a patch.

In addition to specifying the commit for which to generate a patch, callers can provide a since ID revision as the base of the patch, or set all ancestors to true.

Since:

6.7

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PatchCommandParameters.Builder

Field Summary

Fields inherited from class com.atlassian.bitbucket.util.BuilderSupport

NOT_BLANK

Method Summary

Modifier and Type	Method and Description
Repository	getSecondaryRepository()
String	getSinceId() Retrieves the base revision from which to generate the patch.
String	getUntilId()
boolean	isAllAncestors()

Methods inherited from class com.atlassian.bitbucket.util.BuilderSupport

addIf, addIf, addIf, addIf, addIf, addIf, checkNotBlank, requireNonBlank

Methods inherited from class java.lang.Object

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

Method Detail

getSecondaryRepository

@Nullable
public Repository getSecondaryRepository()

getSinceId

@Nullable
public String getSinceId()

Retrieves the base revision from which to generate the patch. If omitted the parent revision of the until ID revision is used.

Returns:

the base revision from which to generate the patch

getUntilId

@Nonnull
public String getUntilId()

isAllAncestors

public boolean isAllAncestors()

Returns:

whether or not to generate a patch which includes all the ancestors of until ID. If true, the value provided by since ID is ignored.