Region

open class Region : PropertyOwner

A region within an artifact where a result was detected.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
@SerializedName(value = "byteLength")
@Expose
open var byteLength: Integer
The length of the region in bytes.
Link copied to clipboard
@SerializedName(value = "byteOffset")
@Expose
open var byteOffset: Integer
The zero-based offset from the beginning of the artifact of the first byte in the region.
Link copied to clipboard
@SerializedName(value = "charLength")
@Expose
open var charLength: Integer
The length of the region in characters.
Link copied to clipboard
@SerializedName(value = "charOffset")
@Expose
open var charOffset: Integer
The zero-based offset from the beginning of the artifact of the first character in the region.
Link copied to clipboard
@SerializedName(value = "endColumn")
@Expose
open var endColumn: Integer
The column number of the character following the end of the region.
Link copied to clipboard
@SerializedName(value = "endLine")
@Expose
open var endLine: Integer
The line number of the last character in the region.
Link copied to clipboard
@SerializedName(value = "message")
@Expose
open var message: Message
Encapsulates a message intended to be read by the end user.
Link copied to clipboard
@SerializedName(value = "properties")
@Expose
open var properties: PropertyBag
Key/value pairs that provide additional information about the object.
Link copied to clipboard
@SerializedName(value = "snippet")
@Expose
open var snippet: ArtifactContent
Represents the contents of an artifact.
Link copied to clipboard
@SerializedName(value = "sourceLanguage")
@Expose
open var sourceLanguage: String
Specifies the source language, if any, of the portion of the artifact specified by the region object.
Link copied to clipboard
@SerializedName(value = "startColumn")
@Expose
open var startColumn: Integer
The column number of the first character in the region.
Link copied to clipboard
@SerializedName(value = "startLine")
@Expose
open var startLine: Integer
The line number of the first character in the region.

Functions

Link copied to clipboard
open fun equals(other: Any): Boolean
Link copied to clipboard
abstract fun getProperties(): PropertyBag
Link copied to clipboard
open fun hashCode(): Int
Link copied to clipboard
abstract fun setProperties(<set-?>: PropertyBag)
Link copied to clipboard
open fun toString(): String
Link copied to clipboard
open fun updateProperties(mutator: (in PropertyBag) -> Unit)
Link copied to clipboard
open fun withByteLength(byteLength: Integer): Region
Link copied to clipboard
open fun withByteOffset(byteOffset: Integer): Region
Link copied to clipboard
open fun withCharLength(charLength: Integer): Region
Link copied to clipboard
open fun withCharOffset(charOffset: Integer): Region
Link copied to clipboard
open fun withEndColumn(endColumn: Integer): Region
Link copied to clipboard
open fun withEndLine(endLine: Integer): Region
Link copied to clipboard
open fun withMessage(message: Message): Region
Link copied to clipboard
open fun withProperties(properties: PropertyBag): Region
Link copied to clipboard
open fun withSnippet(snippet: ArtifactContent): Region
Link copied to clipboard
open fun withSourceLanguage(sourceLanguage: String): Region
Link copied to clipboard
open fun withStartColumn(startColumn: Integer): Region
Link copied to clipboard
open fun withStartLine(startLine: Integer): Region