Package com.atlassian.bitbucket.content

Class PatchRequest

java.lang.Object

com.atlassian.bitbucket.content.PatchRequest

public class PatchRequest
extends Object

Describes a request to format a patch of a given repository for a given commit or commit range.

Since:

6.7

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PatchRequest.Builder

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

getRepository

@Nonnull
public Repository getRepository()

Returns:

the repository

getSecondaryRepository

@Nullable
public Repository getSecondaryRepository()

Retrieves the secondary repository from which to generate the patch. Commits in this repository may only be identified by hash. Any branch or tag names used will always be resolved using the primary repository.

Returns:

a secondary repository from which to generate the patch

getSinceId

@Nullable
public String getSinceId()

Retrieves the base revision from which to generate the patch. This is only applicable when isAllAncestors() is false. If omitted the patch will represent one single commit, the until ID.

Returns:

the base revision from which to generate the patch

getUntilId

@Nonnull
public String getUntilId()

Returns:

the target revision from which to generate the patch

isAllAncestors

public boolean isAllAncestors()

Returns:

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