Package com.atlassian.bitbucket.content

Class DiffStatsSummaryRequest

java.lang.Object

com.atlassian.bitbucket.content.DiffStatsSummaryRequest

public class DiffStatsSummaryRequest
extends Object

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

Since:

9.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DiffStatsSummaryRequest.Builder

Method Summary

Modifier and Type	Method	Description
Set<String>	getPaths()
Repository	getRepository()
Repository	getSecondaryRepository()	Retrieves the secondary repository from which to generate the diff.
String	getSinceId()
String	getUntilId()
DiffWhitespace	getWhitespace()
boolean	isWithAutoSrcPath()

Methods inherited from class java.lang.Object

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

Method Details

getPaths

@Nonnull
public Set<String> getPaths()

Returns:

specific paths to diff, which may be empty to generate the diff for every modified path

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

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

getWhitespace

@Nonnull
public DiffWhitespace getWhitespace()

Returns:

the whitespace mode used in 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.