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

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

```
public class EdgeTraversal
extends Object
```
Represents the traversal of a single edge during a graph traversal.

Constructor Summary

Constructors
Constructor and Description

EdgeTraversal()

Constructors
Constructor and Description
`EdgeTraversal()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`String`	`getEdgeId()` Identifies the edge being traversed.
`FinalState`	`getFinalState()` The values of relevant expressions after the edge has been traversed.
`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.
`Integer`	`getStepOverEdgeCount()` The number of edge traversals necessary to return from a nested graph.
`int`	`hashCode()`
`void`	`setEdgeId(String edgeId)` Identifies the edge being traversed.
`void`	`setFinalState(FinalState finalState)` The values of relevant expressions after the edge has been traversed.
`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`	`setStepOverEdgeCount(Integer stepOverEdgeCount)` The number of edge traversals necessary to return from a nested graph.
`String`	`toString()`
`EdgeTraversal`	`withEdgeId(String edgeId)`
`EdgeTraversal`	`withFinalState(FinalState finalState)`
`EdgeTraversal`	`withMessage(Message message)`
`EdgeTraversal`	`withProperties(PropertyBag properties)`
`EdgeTraversal`	`withStepOverEdgeCount(Integer stepOverEdgeCount)`

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

- Constructor Detail
  - EdgeTraversal
```
public EdgeTraversal()
```
- Method Detail
  - getEdgeId
```
public String getEdgeId()
```
    Identifies the edge being traversed. (Required)
  - setEdgeId
```
public void setEdgeId(String edgeId)
```
    Identifies the edge being traversed. (Required)
  - withEdgeId
```
public EdgeTraversal withEdgeId(String edgeId)
```
  - 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 EdgeTraversal withMessage(Message message)
```
  - getFinalState
```
public FinalState getFinalState()
```
    The values of relevant expressions after the edge has been traversed.
  - setFinalState
```
public void setFinalState(FinalState finalState)
```
    The values of relevant expressions after the edge has been traversed.
  - withFinalState
```
public EdgeTraversal withFinalState(FinalState finalState)
```
  - getStepOverEdgeCount
```
public Integer getStepOverEdgeCount()
```
    The number of edge traversals necessary to return from a nested graph.
  - setStepOverEdgeCount
```
public void setStepOverEdgeCount(Integer stepOverEdgeCount)
```
    The number of edge traversals necessary to return from a nested graph.
  - withStepOverEdgeCount
```
public EdgeTraversal withStepOverEdgeCount(Integer stepOverEdgeCount)
```
  - 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 EdgeTraversal 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 EdgeTraversal

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EdgeTraversal

Method Detail

getEdgeId

setEdgeId

withEdgeId

getMessage

setMessage

withMessage

getFinalState

setFinalState

withFinalState

getStepOverEdgeCount

setStepOverEdgeCount

withStepOverEdgeCount

getProperties

setProperties

withProperties

toString

hashCode

equals