Package com.atlassian.bitbucket.content

Class DiffRequest

java.lang.Object

com.atlassian.bitbucket.content.AbstractDiffRequest

com.atlassian.bitbucket.content.DiffRequest

public class DiffRequest
extends AbstractDiffRequest

Describes a request to generate a diff of a given repository for a given commit or commit range.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DiffRequest.Builder

Nested classes/interfaces inherited from class com.atlassian.bitbucket.content.AbstractDiffRequest

AbstractDiffRequest.AbstractBuilder<B extends AbstractDiffRequest.AbstractBuilder<B,R>,R>

Field Summary

Fields inherited from class com.atlassian.bitbucket.content.AbstractDiffRequest

DEFAULT_CONTEXT_LINES

Method Summary

Modifier and Type	Method	Description
Repository	getRepository()
Repository	getSecondaryRepository()	Retrieves the secondary repository from which to generate the diff.
String	getSinceId()
String	getUntilId()
boolean	isWithAutoSrcPath()
boolean	isWithComments()

Methods inherited from class com.atlassian.bitbucket.content.AbstractDiffRequest

getContextLines, getFilter, getPaths, getWhitespace, hasContextLines

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 to use

getSecondaryRepository

@Nullable
public Repository getSecondaryRepository()

Retrieves the secondary repository from which to generate the diff. 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 diff

Since:

6.7

getSinceId

@Nullable
public String getSinceId()

Returns:

the "since" commit for the diff or null for the untilId's parent

getUntilId

@Nonnull
public String getUntilId()

Returns:

the "until" commit for the diff

isWithAutoSrcPath

public boolean isWithAutoSrcPath()

Returns:

true if attempting to resolve the source path in case of a rename, false otherwise. Only valid for a single path.

Since:

4.5

isWithComments

public boolean isWithComments()

Returns:

true if the comment associated with the diff should be included in the response to this request. false otherwise