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

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

public class GraphTraversal
extends Object

Represents a path through a graph.

Constructor Summary

Constructors
Constructor and Description

GraphTraversal()

Constructors
Constructor and Description
`GraphTraversal()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`Message`	`getDescription()` Encapsulates a message intended to be read by the end user.
`List<EdgeTraversal>`	`getEdgeTraversals()` The sequences of edges traversed by this graph traversal.
`ImmutableState__1`	`getImmutableState()` Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.
`InitialState__1`	`getInitialState()` Values of relevant expressions at the start of the graph traversal that may change during graph traversal.
`PropertyBag`	`getProperties()` Key/value pairs that provide additional information about the object.
`Integer`	`getResultGraphIndex()` The index within the result.graphs to be associated with the result.
`Integer`	`getRunGraphIndex()` The index within the run.graphs to be associated with the result.
`int`	`hashCode()`
`void`	`setDescription(Message description)` Encapsulates a message intended to be read by the end user.
`void`	`setEdgeTraversals(List<EdgeTraversal> edgeTraversals)` The sequences of edges traversed by this graph traversal.
`void`	`setImmutableState(ImmutableState__1 immutableState)` Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.
`void`	`setInitialState(InitialState__1 initialState)` Values of relevant expressions at the start of the graph traversal that may change during graph traversal.
`void`	`setProperties(PropertyBag properties)` Key/value pairs that provide additional information about the object.
`void`	`setResultGraphIndex(Integer resultGraphIndex)` The index within the result.graphs to be associated with the result.
`void`	`setRunGraphIndex(Integer runGraphIndex)` The index within the run.graphs to be associated with the result.
`String`	`toString()`
`GraphTraversal`	`withDescription(Message description)`
`GraphTraversal`	`withEdgeTraversals(List<EdgeTraversal> edgeTraversals)`
`GraphTraversal`	`withImmutableState(ImmutableState__1 immutableState)`
`GraphTraversal`	`withInitialState(InitialState__1 initialState)`
`GraphTraversal`	`withProperties(PropertyBag properties)`
`GraphTraversal`	`withResultGraphIndex(Integer resultGraphIndex)`
`GraphTraversal`	`withRunGraphIndex(Integer runGraphIndex)`

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

- Constructor Detail
  - GraphTraversal
```
public GraphTraversal()
```
- Method Detail
  - getRunGraphIndex
```
public Integer getRunGraphIndex()
```
    The index within the run.graphs to be associated with the result.
  - setRunGraphIndex
```
public void setRunGraphIndex(Integer runGraphIndex)
```
    The index within the run.graphs to be associated with the result.
  - withRunGraphIndex
```
public GraphTraversal withRunGraphIndex(Integer runGraphIndex)
```
  - getResultGraphIndex
```
public Integer getResultGraphIndex()
```
    The index within the result.graphs to be associated with the result.
  - setResultGraphIndex
```
public void setResultGraphIndex(Integer resultGraphIndex)
```
    The index within the result.graphs to be associated with the result.
  - withResultGraphIndex
```
public GraphTraversal withResultGraphIndex(Integer resultGraphIndex)
```
  - getDescription
```
public Message getDescription()
```
    Encapsulates a message intended to be read by the end user.
  - setDescription
```
public void setDescription(Message description)
```
    Encapsulates a message intended to be read by the end user.
  - withDescription
```
public GraphTraversal withDescription(Message description)
```
  - getInitialState
```
public InitialState__1 getInitialState()
```
    Values of relevant expressions at the start of the graph traversal that may change during graph traversal.
  - setInitialState
```
public void setInitialState(InitialState__1 initialState)
```
    Values of relevant expressions at the start of the graph traversal that may change during graph traversal.
  - withInitialState
```
public GraphTraversal withInitialState(InitialState__1 initialState)
```
  - getImmutableState
```
public ImmutableState__1 getImmutableState()
```
    Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.
  - setImmutableState
```
public void setImmutableState(ImmutableState__1 immutableState)
```
    Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.
  - withImmutableState
```
public GraphTraversal withImmutableState(ImmutableState__1 immutableState)
```
  - getEdgeTraversals
```
public List<EdgeTraversal> getEdgeTraversals()
```
    The sequences of edges traversed by this graph traversal.
  - setEdgeTraversals
```
public void setEdgeTraversals(List<EdgeTraversal> edgeTraversals)
```
    The sequences of edges traversed by this graph traversal.
  - withEdgeTraversals
```
public GraphTraversal withEdgeTraversals(List<EdgeTraversal> edgeTraversals)
```
  - 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 GraphTraversal 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 GraphTraversal

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GraphTraversal

Method Detail

getRunGraphIndex

setRunGraphIndex

withRunGraphIndex

getResultGraphIndex

setResultGraphIndex

withResultGraphIndex

getDescription

setDescription

withDescription

getInitialState

setInitialState

withInitialState

getImmutableState

setImmutableState

withImmutableState

getEdgeTraversals

setEdgeTraversals

withEdgeTraversals

getProperties

setProperties

withProperties

toString

hashCode

equals