Path (PLANitAllJava 0.2.0 API)

All Superinterfaces:

Iterable<EdgeSegment>

All Known Implementing Classes:

PathImpl
```
public interface Path
extends Iterable<EdgeSegment>
```
Path interface representing a path through the network on edge segment level

Author:

markr

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Boolean`	`addEdgeSegment(EdgeSegment edgeSegment)`	add an edge segment to the path by appending it
`long`	`getId()`	Return the Id of this path
`String`	`toString(PathOutputIdentificationType pathOutputType)`	Outputs this path as a String, appropriate to a specified path output type

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Method Detail
  - addEdgeSegment
```
Boolean addEdgeSegment(EdgeSegment edgeSegment)
```
    add an edge segment to the path by appending it
    
    Parameters:
    
    edgeSegment - the edge segment to add
    
    Returns:
    
    true as per Collection.add
  - toString
```
String toString(PathOutputIdentificationType pathOutputType)
```
    Outputs this path as a String, appropriate to a specified path output type
    
    Parameters:
    
    pathOutputType - the specified path output type
    
    Returns:
    
    String describing the path
  - getId
```
long getId()
```
    Return the Id of this path
    
    Returns:
    
    the Id of this path