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

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

```
public class ThreadFlow
extends Object
```
Describes a sequence of code locations that specify a path through a single thread of execution such as an operating system or fiber.

Constructor Summary

Constructors
Constructor and Description

ThreadFlow()

Constructors
Constructor and Description
`ThreadFlow()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`String`	`getId()` An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.
`ImmutableState`	`getImmutableState()` Values of relevant expressions at the start of the thread flow that remain constant.
`InitialState`	`getInitialState()` Values of relevant expressions at the start of the thread flow that may change during thread flow execution.
`List<ThreadFlowLocation>`	`getLocations()` A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.
`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.
`int`	`hashCode()`
`void`	`setId(String id)` An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.
`void`	`setImmutableState(ImmutableState immutableState)` Values of relevant expressions at the start of the thread flow that remain constant.
`void`	`setInitialState(InitialState initialState)` Values of relevant expressions at the start of the thread flow that may change during thread flow execution.
`void`	`setLocations(List<ThreadFlowLocation> locations)` A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.
`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.
`String`	`toString()`
`ThreadFlow`	`withId(String id)`
`ThreadFlow`	`withImmutableState(ImmutableState immutableState)`
`ThreadFlow`	`withInitialState(InitialState initialState)`
`ThreadFlow`	`withLocations(List<ThreadFlowLocation> locations)`
`ThreadFlow`	`withMessage(Message message)`
`ThreadFlow`	`withProperties(PropertyBag properties)`

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

- Constructor Detail
  - ThreadFlow
```
public ThreadFlow()
```
- Method Detail
  - getId
```
public String getId()
```
    An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.
  - setId
```
public void setId(String id)
```
    An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.
  - withId
```
public ThreadFlow withId(String id)
```
  - 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 ThreadFlow withMessage(Message message)
```
  - getInitialState
```
public InitialState getInitialState()
```
    Values of relevant expressions at the start of the thread flow that may change during thread flow execution.
  - setInitialState
```
public void setInitialState(InitialState initialState)
```
    Values of relevant expressions at the start of the thread flow that may change during thread flow execution.
  - withInitialState
```
public ThreadFlow withInitialState(InitialState initialState)
```
  - getImmutableState
```
public ImmutableState getImmutableState()
```
    Values of relevant expressions at the start of the thread flow that remain constant.
  - setImmutableState
```
public void setImmutableState(ImmutableState immutableState)
```
    Values of relevant expressions at the start of the thread flow that remain constant.
  - withImmutableState
```
public ThreadFlow withImmutableState(ImmutableState immutableState)
```
  - getLocations
```
public List<ThreadFlowLocation> getLocations()
```
    A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result. (Required)
  - setLocations
```
public void setLocations(List<ThreadFlowLocation> locations)
```
    A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result. (Required)
  - withLocations
```
public ThreadFlow withLocations(List<ThreadFlowLocation> locations)
```
  - 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 ThreadFlow 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 ThreadFlow

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ThreadFlow

Method Detail

getId

setId

withId

getMessage

setMessage

withMessage

getInitialState

setInitialState

withInitialState

getImmutableState

setImmutableState

withImmutableState

getLocations

setLocations

withLocations

getProperties

setProperties

withProperties

toString

hashCode

equals