com.atlassian.bitbucket.comment

Interface CommentThreadDiffAnchor

public interface CommentThreadDiffAnchor

The location in a diff a comment thread is anchored to.

Since:

5.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_LINE

Method Summary

Modifier and Type	Method and Description
CommentThreadDiffAnchorType	getDiffType()
Optional<DiffFileType>	getFileType() File type this anchor is anchored to in a diff.
Optional<String>	getFromHash()
int	getLine()
Optional<DiffSegmentType>	getLineType()
String	getPath()
Optional<String>	getSrcPath() The original path at which the content pointed to by this anchor originated, or Optional.empty() if the change was not one that produces a new path.
String	getToHash()
boolean	isFileAnchor()
boolean	isLineAnchor()
boolean	isOrphaned() An orphaned anchor point is out-of-date in the current state of a diff.

Field Detail

NO_LINE

static final int NO_LINE

See Also:

Constant Field Values

Method Detail

getDiffType

@Nonnull
CommentThreadDiffAnchorType getDiffType()

Returns:

the diff type associated with this anchor

getFileType

@Nonnull
Optional<DiffFileType> getFileType()

File type this anchor is anchored to in a diff.

The following relationship with getLineType() occurs:

• for DiffSegmentType.REMOVED this will always be DiffFileType.FROM
• for DiffSegmentType.ADDED this will always be DiffFileType.TO
• for DiffSegmentType.CONTEXT the anchor can be hooked to any of the diff files

Returns:

type of the file this anchor is anchored to in a diff. It will only be present if this is a line anchor

See Also:

DiffFileType

getFromHash

@Nonnull
Optional<String> getFromHash()

getLine

int getLine()

getLineType

@Nonnull
Optional<DiffSegmentType> getLineType()

Returns:

type of the line this anchor is anchored to. It will only be present if this is a line anchor

See Also:

DiffSegmentType

getPath

@Nonnull
String getPath()

Returns:

the path to the contents this anchor points to

getSrcPath

@Nonnull
Optional<String> getSrcPath()

The original path at which the content pointed to by this anchor originated, or Optional.empty() if the change was not one that produces a new path.

Returns:

the original path of the contents referred to by this anchor

getToHash

@Nonnull
String getToHash()

isFileAnchor

boolean isFileAnchor()

Returns:

true, if this is a file comment anchor, i.e. an anchor associated with the whole file rather than a particular line. true implies that isLineAnchor() returns false.

See Also:

isLineAnchor()

isLineAnchor

boolean isLineAnchor()

Returns:

true, if this is a line comment anchor, i.e. an anchor associated with a particular line in the file. true implies that isFileAnchor() returns false.

See Also:

isFileAnchor()

isOrphaned

boolean isOrphaned()

An orphaned anchor point is out-of-date in the current state of a diff. E.g. the anchor points to a path that is no longer in scope of the pull request, because the changes to that file have been reverted on the source branch.

Returns:

true, if the anchor is orphaned, false otherwise