ai.nightfall.scan.model

Class Location

java.lang.Object

ai.nightfall.scan.model.Location

public class Location
extends Object

An object representing where a finding was discovered in content.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Location.Range An object that contains references to the start and end of the eponymous range.

Constructor Summary

Constructors

Constructor and Description
Location()

Method Summary

Modifier and Type	Method and Description
Location.Range	getByteRange() Get the finding's byte range.
Location.Range	getCodepointRange() Get the finding's codepoint range.
Location.Range	getColumnRange() Get the finding's column range.
String	getCommitAuthor() Get the finding's commit author.
String	getCommitHash() Get the finding's commit hash.
Location.Range	getRowRange() Get the finding's row range.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Location

public Location()

Method Detail

getByteRange

public Location.Range getByteRange()

Get the finding's byte range.

Returns:

the byte range in which a finding was detected

getCodepointRange

public Location.Range getCodepointRange()

Get the finding's codepoint range.

Returns:

the codepoint range in which a finding was detected. This differs from byte range since a codepoint may contain multiple bytes.

getRowRange

public Location.Range getRowRange()

Get the finding's row range.

Returns:

the row range in which a finding was detected, if it is tabular.

getColumnRange

public Location.Range getColumnRange()

Get the finding's column range.

Returns:

the column range in which a finding was detected, if it is tabular.

getCommitHash

public String getCommitHash()

Get the finding's commit hash.

Returns:

the hash of the commit in which a finding was detected if known.

getCommitAuthor

public String getCommitAuthor()

Get the finding's commit author.

Returns:

the author of the commit in which a finding was detected if known.

toString

public String toString()

Overrides:

toString in class Object