IntPath (graph 2.7.0.2 API)

java.lang.Object
- com.mastfrog.graph.IntPath

All Implemented Interfaces:

Comparable<IntPath>, Iterable<Integer>
```
public final class IntPath
extends Object
implements Comparable<IntPath>, Iterable<Integer>
```
A finite path between two elements in a graph.

Author:

Tim Boudreau

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`IntPath`	`appending(int value)` Create a new path appending the passed value.
`IntPath`	`childPath()` Create a new path, lopping off the first element.
`int`	`compareTo(IntPath o)`
`boolean`	`contains(int val)` Determine if this path contains the passed value.
`boolean`	`contains(IntPath path)` Determine if this path contains the subsequence in the passed path, or is equal to it.
`int`	`end()`
`boolean`	`equals(Object o)`
`int`	`first()` Get the first path element
`void`	`forEachInt(IntConsumer c)` Iterate all elements of the path, passing them to the passed consumer.
`void`	`forEachIntReversed(IntConsumer c)` Iterate all elements of the path in reverse order, passing them to the passed consumer.
`int`	`get(int index)` Get the path element at the specified index.
`int`	`hashCode()`
`int`	`indexOf(int val)` Get the first occurrence of the passed value in this path.
`boolean`	`isEmpty()` Determine if this path is empty.
`boolean`	`isNotAPath()` Determine if this path does not represent an actual path - if it has one element or less.
`int[]`	`items()` Get the contents of this path as an int[].
`void`	`iterate(IntConsumer cons)` Deprecated. use the better-named `forEachInt()`
`Iterator<Integer>`	`iterator()`
`int`	`last()` Get the last path element
`int`	`lastIndexOf(int val)` Get the first occurrence of the passed value in this path.
`IntPath`	`parentPath()` Create a new path, lopping off the last element.
`IntPath`	`prepending(int value)` Create a new path prepending the passed value.
`IntPath`	`reversed()` Create a new path whose elements are this one's in reverse order.
`int`	`size()` Get the number of elements in this path.
`int`	`start()`
`<T> ObjectPath<T>`	`toObjectPath(com.mastfrog.abstractions.list.IndexedResolvable<T> indexed)`
`String`	`toString()`

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

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

- Method Detail
  - prepending
```
public IntPath prepending(int value)
```
    Create a new path prepending the passed value.
    
    Parameters:
    
    value - A value
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - if the value is negative
  - appending
```
public IntPath appending(int value)
```
    Create a new path appending the passed value.
    
    Parameters:
    
    value - A value
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - if the value is negative
  - forEachInt
```
public void forEachInt(IntConsumer c)
```
    Iterate all elements of the path, passing them to the passed consumer.
    
    Parameters:
    
    c - A consumer
  - forEachIntReversed
```
public void forEachIntReversed(IntConsumer c)
```
    Iterate all elements of the path in reverse order, passing them to the passed consumer.
    
    Parameters:
    
    c - A consumer
  - first
```
public int first()
```
    Get the first path element
    
    Returns:
    
    The first path element
    
    Throws:
    
    IndexOutOfBoundsException - if out of range
  - last
```
public int last()
```
    Get the last path element
    
    Returns:
    
    The first path element
    
    Throws:
    
    IndexOutOfBoundsException - if out of range
  - childPath
```
public IntPath childPath()
```
    Create a new path, lopping off the first element.
    
    Returns:
    
    A new path
  - parentPath
```
public IntPath parentPath()
```
    Create a new path, lopping off the last element.
    
    Returns:
    
    A new path
  - reversed
```
public IntPath reversed()
```
    Create a new path whose elements are this one's in reverse order.
    
    Returns:
    
    A new path
  - start
```
public int start()
```
  - end
```
public int end()
```
  - contains
```
public boolean contains(IntPath path)
```
    Determine if this path contains the subsequence in the passed path, or is equal to it.
    
    Parameters:
    
    path - A path
    
    Returns:
    
    true if this path contains the passed one
  - indexOf
```
public int indexOf(int val)
```
    Get the first occurrence of the passed value in this path.
    
    Parameters:
    
    val - An integer path element
    
    Returns:
    
    the index or -1
  - lastIndexOf
```
public int lastIndexOf(int val)
```
    Get the first occurrence of the passed value in this path.
    
    Parameters:
    
    val - An integer path element
    
    Returns:
    
    the index or -1
  - contains
```
public boolean contains(int val)
```
    Determine if this path contains the passed value.
    
    Parameters:
    
    val - A value
    
    Returns:
    
    true if it is present
  - isEmpty
```
public boolean isEmpty()
```
    Determine if this path is empty.
    
    Returns:
    
    True if it is empty
  - size
```
public int size()
```
    Get the number of elements in this path.
    
    Returns:
    
    The number of elements
  - isNotAPath
```
public boolean isNotAPath()
```
    Determine if this path does not represent an actual path - if it has one element or less.
    
    Returns:
    
    True if this path does not have an endpoint and may or may not have a start point
  - get
```
public int get(int index)
```
    Get the path element at the specified index.
    
    Parameters:
    
    index - The index within the path
    
    Returns:
    
    The index or -1 if not present
  - items
```
public int[] items()
```
    Get the contents of this path as an int[].
    
    Returns:
    
    An array
  - iterate
```
@Deprecated
public void iterate(IntConsumer cons)
```
    Deprecated. use the better-named forEachInt()
    
    Iterate the contents.
    
    Parameters:
    
    cons -
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toObjectPath
```
public <T> ObjectPath<T> toObjectPath(com.mastfrog.abstractions.list.IndexedResolvable<T> indexed)
```
  - compareTo
```
public int compareTo(IntPath o)
```
    Specified by:
    
    compareTo in interface Comparable<IntPath>
  - iterator
```
public Iterator<Integer> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Integer>

Class IntPath

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

prepending

appending

forEachInt

forEachIntReversed

first

last

childPath

parentPath

reversed

start

end

contains

indexOf

lastIndexOf

contains

isEmpty

size

isNotAPath

get

items

iterate

equals

hashCode

toString

toObjectPath

compareTo

iterator