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

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

```
public class ThreadFlowLocation
extends Object
```
A location visited by an analysis tool while simulating or monitoring the execution of a program.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ThreadFlowLocation.Importance` Specifies the importance of this location in understanding the code flow in which it occurs.

Constructor Summary

Constructors
Constructor and Description

ThreadFlowLocation()

Constructors
Constructor and Description
`ThreadFlowLocation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`Integer`	`getExecutionOrder()` An integer representing the temporal order in which execution reached this location.
`Date`	`getExecutionTimeUtc()` The Coordinated Universal Time (UTC) date and time at which this location was executed.
`ThreadFlowLocation.Importance`	`getImportance()` Specifies the importance of this location in understanding the code flow in which it occurs.
`Integer`	`getIndex()` The index within the run threadFlowLocations array.
`Set<String>`	`getKinds()` A set of distinct strings that categorize the thread flow location.
`Location`	`getLocation()` A location within a programming artifact.
`String`	`getModule()` The name of the module that contains the code that is executing.
`Integer`	`getNestingLevel()` An integer representing a containment hierarchy within the thread flow.
`PropertyBag`	`getProperties()` Key/value pairs that provide additional information about the object.
`Stack`	`getStack()` A call stack that is relevant to a result.
`State`	`getState()` A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value.
`Set<ReportingDescriptorReference>`	`getTaxa()` An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.
`WebRequest`	`getWebRequest()` Describes an HTTP request.
`WebResponse`	`getWebResponse()` Describes the response to an HTTP request.
`int`	`hashCode()`
`void`	`setExecutionOrder(Integer executionOrder)` An integer representing the temporal order in which execution reached this location.
`void`	`setExecutionTimeUtc(Date executionTimeUtc)` The Coordinated Universal Time (UTC) date and time at which this location was executed.
`void`	`setImportance(ThreadFlowLocation.Importance importance)` Specifies the importance of this location in understanding the code flow in which it occurs.
`void`	`setIndex(Integer index)` The index within the run threadFlowLocations array.
`void`	`setKinds(Set<String> kinds)` A set of distinct strings that categorize the thread flow location.
`void`	`setLocation(Location location)` A location within a programming artifact.
`void`	`setModule(String module)` The name of the module that contains the code that is executing.
`void`	`setNestingLevel(Integer nestingLevel)` An integer representing a containment hierarchy within the thread flow.
`void`	`setProperties(PropertyBag properties)` Key/value pairs that provide additional information about the object.
`void`	`setStack(Stack stack)` A call stack that is relevant to a result.
`void`	`setState(State state)` A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value.
`void`	`setTaxa(Set<ReportingDescriptorReference> taxa)` An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.
`void`	`setWebRequest(WebRequest webRequest)` Describes an HTTP request.
`void`	`setWebResponse(WebResponse webResponse)` Describes the response to an HTTP request.
`String`	`toString()`
`ThreadFlowLocation`	`withExecutionOrder(Integer executionOrder)`
`ThreadFlowLocation`	`withExecutionTimeUtc(Date executionTimeUtc)`
`ThreadFlowLocation`	`withImportance(ThreadFlowLocation.Importance importance)`
`ThreadFlowLocation`	`withIndex(Integer index)`
`ThreadFlowLocation`	`withKinds(Set<String> kinds)`
`ThreadFlowLocation`	`withLocation(Location location)`
`ThreadFlowLocation`	`withModule(String module)`
`ThreadFlowLocation`	`withNestingLevel(Integer nestingLevel)`
`ThreadFlowLocation`	`withProperties(PropertyBag properties)`
`ThreadFlowLocation`	`withStack(Stack stack)`
`ThreadFlowLocation`	`withState(State state)`
`ThreadFlowLocation`	`withTaxa(Set<ReportingDescriptorReference> taxa)`
`ThreadFlowLocation`	`withWebRequest(WebRequest webRequest)`
`ThreadFlowLocation`	`withWebResponse(WebResponse webResponse)`

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

- Constructor Detail
  - ThreadFlowLocation
```
public ThreadFlowLocation()
```
- Method Detail
  - getIndex
```
public Integer getIndex()
```
    The index within the run threadFlowLocations array.
  - setIndex
```
public void setIndex(Integer index)
```
    The index within the run threadFlowLocations array.
  - withIndex
```
public ThreadFlowLocation withIndex(Integer index)
```
  - getLocation
```
public Location getLocation()
```
    A location within a programming artifact.
  - setLocation
```
public void setLocation(Location location)
```
    A location within a programming artifact.
  - withLocation
```
public ThreadFlowLocation withLocation(Location location)
```
  - getStack
```
public Stack getStack()
```
    A call stack that is relevant to a result.
  - setStack
```
public void setStack(Stack stack)
```
    A call stack that is relevant to a result.
  - withStack
```
public ThreadFlowLocation withStack(Stack stack)
```
  - getKinds
```
public Set<String> getKinds()
```
    A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.
  - setKinds
```
public void setKinds(Set<String> kinds)
```
    A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.
  - withKinds
```
public ThreadFlowLocation withKinds(Set<String> kinds)
```
  - getTaxa
```
public Set<ReportingDescriptorReference> getTaxa()
```
    An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.
  - setTaxa
```
public void setTaxa(Set<ReportingDescriptorReference> taxa)
```
    An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.
  - withTaxa
```
public ThreadFlowLocation withTaxa(Set<ReportingDescriptorReference> taxa)
```
  - getModule
```
public String getModule()
```
    The name of the module that contains the code that is executing.
  - setModule
```
public void setModule(String module)
```
    The name of the module that contains the code that is executing.
  - withModule
```
public ThreadFlowLocation withModule(String module)
```
  - getState
```
public State getState()
```
    A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.
  - setState
```
public void setState(State state)
```
    A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.
  - withState
```
public ThreadFlowLocation withState(State state)
```
  - getNestingLevel
```
public Integer getNestingLevel()
```
    An integer representing a containment hierarchy within the thread flow.
  - setNestingLevel
```
public void setNestingLevel(Integer nestingLevel)
```
    An integer representing a containment hierarchy within the thread flow.
  - withNestingLevel
```
public ThreadFlowLocation withNestingLevel(Integer nestingLevel)
```
  - getExecutionOrder
```
public Integer getExecutionOrder()
```
    An integer representing the temporal order in which execution reached this location.
  - setExecutionOrder
```
public void setExecutionOrder(Integer executionOrder)
```
    An integer representing the temporal order in which execution reached this location.
  - withExecutionOrder
```
public ThreadFlowLocation withExecutionOrder(Integer executionOrder)
```
  - getExecutionTimeUtc
```
public Date getExecutionTimeUtc()
```
    The Coordinated Universal Time (UTC) date and time at which this location was executed.
  - setExecutionTimeUtc
```
public void setExecutionTimeUtc(Date executionTimeUtc)
```
    The Coordinated Universal Time (UTC) date and time at which this location was executed.
  - withExecutionTimeUtc
```
public ThreadFlowLocation withExecutionTimeUtc(Date executionTimeUtc)
```
  - getImportance
```
public ThreadFlowLocation.Importance getImportance()
```
    Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is "essential", "important", "unimportant". Default: "important".
  - setImportance
```
public void setImportance(ThreadFlowLocation.Importance importance)
```
    Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is "essential", "important", "unimportant". Default: "important".
  - withImportance
```
public ThreadFlowLocation withImportance(ThreadFlowLocation.Importance importance)
```
  - getWebRequest
```
public WebRequest getWebRequest()
```
    Describes an HTTP request.
  - setWebRequest
```
public void setWebRequest(WebRequest webRequest)
```
    Describes an HTTP request.
  - withWebRequest
```
public ThreadFlowLocation withWebRequest(WebRequest webRequest)
```
  - getWebResponse
```
public WebResponse getWebResponse()
```
    Describes the response to an HTTP request.
  - setWebResponse
```
public void setWebResponse(WebResponse webResponse)
```
    Describes the response to an HTTP request.
  - withWebResponse
```
public ThreadFlowLocation withWebResponse(WebResponse webResponse)
```
  - 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 ThreadFlowLocation 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 ThreadFlowLocation

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ThreadFlowLocation

Method Detail

getIndex

setIndex

withIndex

getLocation

setLocation

withLocation

getStack

setStack

withStack

getKinds

setKinds

withKinds

getTaxa

setTaxa

withTaxa

getModule

setModule

withModule

getState

setState

withState

getNestingLevel

setNestingLevel

withNestingLevel

getExecutionOrder

setExecutionOrder

withExecutionOrder

getExecutionTimeUtc

setExecutionTimeUtc

withExecutionTimeUtc

getImportance

setImportance

withImportance

getWebRequest

setWebRequest

withWebRequest

getWebResponse

setWebResponse

withWebResponse

getProperties

setProperties

withProperties

toString

hashCode

equals