Region (com.contrastsecurity:java-sarif 1.0 API)

java.lang.Object
- com.contrastsecurity.sarif.Region

```
public class Region
extends Object
```
A region within an artifact where a result was detected.

Constructor Summary

Constructors
Constructor and Description

Region()

Constructors
Constructor and Description
`Region()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`Integer`	`getByteLength()` The length of the region in bytes.
`Integer`	`getByteOffset()` The zero-based offset from the beginning of the artifact of the first byte in the region.
`Integer`	`getCharLength()` The length of the region in characters.
`Integer`	`getCharOffset()` The zero-based offset from the beginning of the artifact of the first character in the region.
`Integer`	`getEndColumn()` The column number of the character following the end of the region.
`Integer`	`getEndLine()` The line number of the last character in the region.
`Message`	`getMessage()` Encapsulates a message intended to be read by the end user.
`PropertyBag`	`getProperties()` Key/value pairs that provide additional information about the object.
`ArtifactContent`	`getSnippet()` Represents the contents of an artifact.
`String`	`getSourceLanguage()` Specifies the source language, if any, of the portion of the artifact specified by the region object.
`Integer`	`getStartColumn()` The column number of the first character in the region.
`Integer`	`getStartLine()` The line number of the first character in the region.
`int`	`hashCode()`
`void`	`setByteLength(Integer byteLength)` The length of the region in bytes.
`void`	`setByteOffset(Integer byteOffset)` The zero-based offset from the beginning of the artifact of the first byte in the region.
`void`	`setCharLength(Integer charLength)` The length of the region in characters.
`void`	`setCharOffset(Integer charOffset)` The zero-based offset from the beginning of the artifact of the first character in the region.
`void`	`setEndColumn(Integer endColumn)` The column number of the character following the end of the region.
`void`	`setEndLine(Integer endLine)` The line number of the last character in the region.
`void`	`setMessage(Message message)` Encapsulates a message intended to be read by the end user.
`void`	`setProperties(PropertyBag properties)` Key/value pairs that provide additional information about the object.
`void`	`setSnippet(ArtifactContent snippet)` Represents the contents of an artifact.
`void`	`setSourceLanguage(String sourceLanguage)` Specifies the source language, if any, of the portion of the artifact specified by the region object.
`void`	`setStartColumn(Integer startColumn)` The column number of the first character in the region.
`void`	`setStartLine(Integer startLine)` The line number of the first character in the region.
`String`	`toString()`
`Region`	`withByteLength(Integer byteLength)`
`Region`	`withByteOffset(Integer byteOffset)`
`Region`	`withCharLength(Integer charLength)`
`Region`	`withCharOffset(Integer charOffset)`
`Region`	`withEndColumn(Integer endColumn)`
`Region`	`withEndLine(Integer endLine)`
`Region`	`withMessage(Message message)`
`Region`	`withProperties(PropertyBag properties)`
`Region`	`withSnippet(ArtifactContent snippet)`
`Region`	`withSourceLanguage(String sourceLanguage)`
`Region`	`withStartColumn(Integer startColumn)`
`Region`	`withStartLine(Integer startLine)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Region
```
public Region()
```
- Method Detail
  - getStartLine
```
public Integer getStartLine()
```
    The line number of the first character in the region.
  - setStartLine
```
public void setStartLine(Integer startLine)
```
    The line number of the first character in the region.
  - withStartLine
```
public Region withStartLine(Integer startLine)
```
  - getStartColumn
```
public Integer getStartColumn()
```
    The column number of the first character in the region.
  - setStartColumn
```
public void setStartColumn(Integer startColumn)
```
    The column number of the first character in the region.
  - withStartColumn
```
public Region withStartColumn(Integer startColumn)
```
  - getEndLine
```
public Integer getEndLine()
```
    The line number of the last character in the region.
  - setEndLine
```
public void setEndLine(Integer endLine)
```
    The line number of the last character in the region.
  - withEndLine
```
public Region withEndLine(Integer endLine)
```
  - getEndColumn
```
public Integer getEndColumn()
```
    The column number of the character following the end of the region.
  - setEndColumn
```
public void setEndColumn(Integer endColumn)
```
    The column number of the character following the end of the region.
  - withEndColumn
```
public Region withEndColumn(Integer endColumn)
```
  - getCharOffset
```
public Integer getCharOffset()
```
    The zero-based offset from the beginning of the artifact of the first character in the region.
  - setCharOffset
```
public void setCharOffset(Integer charOffset)
```
    The zero-based offset from the beginning of the artifact of the first character in the region.
  - withCharOffset
```
public Region withCharOffset(Integer charOffset)
```
  - getCharLength
```
public Integer getCharLength()
```
    The length of the region in characters.
  - setCharLength
```
public void setCharLength(Integer charLength)
```
    The length of the region in characters.
  - withCharLength
```
public Region withCharLength(Integer charLength)
```
  - getByteOffset
```
public Integer getByteOffset()
```
    The zero-based offset from the beginning of the artifact of the first byte in the region.
  - setByteOffset
```
public void setByteOffset(Integer byteOffset)
```
    The zero-based offset from the beginning of the artifact of the first byte in the region.
  - withByteOffset
```
public Region withByteOffset(Integer byteOffset)
```
  - getByteLength
```
public Integer getByteLength()
```
    The length of the region in bytes.
  - setByteLength
```
public void setByteLength(Integer byteLength)
```
    The length of the region in bytes.
  - withByteLength
```
public Region withByteLength(Integer byteLength)
```
  - getSnippet
```
public ArtifactContent getSnippet()
```
    Represents the contents of an artifact.
  - setSnippet
```
public void setSnippet(ArtifactContent snippet)
```
    Represents the contents of an artifact.
  - withSnippet
```
public Region withSnippet(ArtifactContent snippet)
```
  - getMessage
```
public Message getMessage()
```
    Encapsulates a message intended to be read by the end user.
  - setMessage
```
public void setMessage(Message message)
```
    Encapsulates a message intended to be read by the end user.
  - withMessage
```
public Region withMessage(Message message)
```
  - getSourceLanguage
```
public String getSourceLanguage()
```
    Specifies the source language, if any, of the portion of the artifact specified by the region object.
  - setSourceLanguage
```
public void setSourceLanguage(String sourceLanguage)
```
    Specifies the source language, if any, of the portion of the artifact specified by the region object.
  - withSourceLanguage
```
public Region withSourceLanguage(String sourceLanguage)
```
  - getProperties
```
public PropertyBag getProperties()
```
    Key/value pairs that provide additional information about the object.
  - setProperties
```
public void setProperties(PropertyBag properties)
```
    Key/value pairs that provide additional information about the object.
  - withProperties
```
public Region withProperties(PropertyBag properties)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object

Class Region

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Region

Method Detail

getStartLine

setStartLine

withStartLine

getStartColumn

setStartColumn

withStartColumn

getEndLine

setEndLine

withEndLine

getEndColumn

setEndColumn

withEndColumn

getCharOffset

setCharOffset

withCharOffset

getCharLength

setCharLength

withCharLength

getByteOffset

setByteOffset

withByteOffset

getByteLength

setByteLength

withByteLength

getSnippet

setSnippet

withSnippet

getMessage

setMessage

withMessage

getSourceLanguage

setSourceLanguage

withSourceLanguage

getProperties

setProperties

withProperties

toString

hashCode

equals