ObjectPath (graph 2.7.0.2 API)

java.lang.Object
- com.mastfrog.graph.ObjectPath<T>

All Implemented Interfaces:

Comparable<ObjectPath>, Iterable<T>
```
public final class ObjectPath<T>
extends Object
implements Iterable<T>, Comparable<ObjectPath>
```
One path in an object graph.

Author:

Tim Boudreau

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ObjectPath`	`appending(T obj)` Create a new path appending the passed object.
`ObjectPath<T>`	`childPath()` Get a copy of this path, lopping off the first element.
`int`	`compareTo(ObjectPath o)`
`boolean`	`contains(T obj)` Determine if this path contains the passed item.
`boolean`	`containsPath(ObjectPath<T> other)` Determine if this path contains the sequence of elements in another path.
`Set<? extends T>`	`contents()` Get all of the contained objects as a set.
`T`	`end()`
`boolean`	`equals(Object o)`
`T`	`first()` Returns the first element.
`T`	`get(int i)` Get the path element at index i.
`int`	`hashCode()`
`int`	`indexOf(T obj)` Get the (first) index of an item 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.
`Iterator<T>`	`iterator()`
`T`	`last()` Returns the last element.
`int`	`lastIndexOf(T obj)` Get the (first) index of an item in this path.
`ObjectPath<T>`	`parentPath()` Get a copy of this path, lopping off the last element.
`ObjectPath`	`prepending(T obj)` Create a new path prepending the passed object.
`ObjectPath<T>`	`reversed()` Create a new path whose elements are this one's in reverse order.
`int`	`size()` Get the number of elements in this path.
`T`	`start()`
`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 ObjectPath prepending(T obj)
```
    Create a new path prepending the passed object.
    
    Parameters:
    
    obj - Another object, which must actually be contained in the original graph this path came from, or null will be returned
    
    Returns:
    
    A new path or null
  - appending
```
public ObjectPath appending(T obj)
```
    Create a new path appending the passed object.
    
    Parameters:
    
    obj - Another object, which must actually be contained in the original graph this path came from, or null will be returned
    
    Returns:
    
    A new path or null
  - contents
```
public Set<? extends T> contents()
```
    Get all of the contained objects as a set.
    
    Returns:
    
    A set
  - size
```
public int size()
```
    Get the number of elements in this path.
    
    Returns:
    
    The size
  - first
```
public T first()
```
    Returns the first element.
    
    Returns:
    
    The first element
    
    Throws:
    
    NoSuchElementException - if the path is empty
  - last
```
public T last()
```
    Returns the last element.
    
    Returns:
    
    The last element
    
    Throws:
    
    NoSuchElementException - if the path is empty
  - get
```
public T get(int i)
```
    Get the path element at index i.
    
    Parameters:
    
    i - An index >=0 and < size()
    
    Returns:
    
    A path element
  - containsPath
```
public boolean containsPath(ObjectPath<T> other)
```
    Determine if this path contains the sequence of elements in another path.
    
    Parameters:
    
    other - Another path
    
    Returns:
    
    true if the passed path is equal to or a subpath of this one
  - contains
```
public boolean contains(T obj)
```
    Determine if this path contains the passed item.
    
    Parameters:
    
    obj -
    
    Returns:
  - indexOf
```
public int indexOf(T obj)
```
    Get the (first) index of an item in this path.
    
    Parameters:
    
    obj - An object
    
    Returns:
    
    the index or -1 if not present
  - lastIndexOf
```
public int lastIndexOf(T obj)
```
    Get the (first) index of an item in this path.
    
    Parameters:
    
    obj - An object
    
    Returns:
    
    the index or -1 if not present
  - childPath
```
public ObjectPath<T> childPath()
```
    Get a copy of this path, lopping off the first element.
    
    Returns:
    
    A new path
  - parentPath
```
public ObjectPath<T> parentPath()
```
    Get a copy of this path, lopping off the last element.
    
    Returns:
    
    A new path
  - isEmpty
```
public boolean isEmpty()
```
    Determine if this path is empty.
    
    Returns:
    
    True if the path contains no 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
  - reversed
```
public ObjectPath<T> reversed()
```
    Create a new path whose elements are this one's in reverse order.
    
    Returns:
    
    A new path
  - start
```
public T start()
```
  - end
```
public T end()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - iterator
```
public Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Iterable<T>
  - compareTo
```
public int compareTo(ObjectPath o)
```
    Specified by:
    
    compareTo in interface Comparable<ObjectPath>

Class ObjectPath<T>

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

prepending

appending

contents

size

first

last

get

containsPath

contains

indexOf

lastIndexOf

childPath

parentPath

isEmpty

isNotAPath

reversed

start

end

hashCode

toString

equals

iterator

compareTo