com.atlassian.bitbucket.content

Class AbstractDiffRequest

java.lang.Object

com.atlassian.bitbucket.content.AbstractDiffRequest

Direct Known Subclasses:

CompareDiffRequest, DiffRequest

public abstract class AbstractDiffRequest
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractDiffRequest.AbstractBuilder<B extends AbstractDiffRequest.AbstractBuilder<B,R>,R>

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONTEXT_LINES Indicates the request should supply the default number of context lines for added and removed lines.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDiffRequest(AbstractDiffRequest.AbstractBuilder<?,?> builder)

Method Summary

Modifier and Type	Method and Description
int	getContextLines() Retrieves the numbers of context lines to show around added and removed lines.
DiffContentFilter	getFilter()
Set<String>	getPaths()
DiffWhitespace	getWhitespace()
boolean	hasContextLines() Retrieves a flag indicating whether an explicit number of context lines has been requested.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTEXT_LINES

public static final int DEFAULT_CONTEXT_LINES

Indicates the request should supply the default number of context lines for added and removed lines. The default is configurable, so it may be changed by a system administrator. The shipped setting is 10 lines.

See Also:

Constant Field Values

Constructor Detail

AbstractDiffRequest

protected AbstractDiffRequest(AbstractDiffRequest.AbstractBuilder<?,?> builder)

Method Detail

getContextLines

public int getContextLines()

Retrieves the numbers of context lines to show around added and removed lines. If the value is 0 context will be omitted and only added and removed lines will be shown. For positive values, that number of lines will be shown. For negative values, the system-configured default number will be shown.

Returns:

the number of context lines that should be included around added and removed lines in the diff

getFilter

@Nullable
public DiffContentFilter getFilter()

Returns:

an optional filter for this diff to filter out lines (and their surrounding file/hunk/segment)

getPaths

@Nonnull
public Set<String> getPaths()

Returns:

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

getWhitespace

@Nonnull
public DiffWhitespace getWhitespace()

Returns:

the whitespace settings used in the diff

hasContextLines

public boolean hasContextLines()

Retrieves a flag indicating whether an explicit number of context lines has been requested. When this method returns true, getContextLines() will return a value greater than or equal to 0, When it returns false, getContextLines() will return DEFAULT_CONTEXT_LINES.

Returns:

true if a non-default number of context lines has been requested; otherwise, false to use the default number of lines