Path (dbrain-data 0.20 API)

All Known Implementing Classes:

PathImpl
```
public interface Path
```
Describe a data path.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface Path.Builder
Builder interface for the Path.

static class Path.NodeType
Describe the node type.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Path.Builder` Builder interface for the Path.
`static class`	`Path.NodeType` Describe the node type.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Path`	`append(Path toAppend)`
`Path`	`append(String toAppend)`
`String`	`attr(int i)`
`static Path`	`empty()`
`static Path.Builder`	`from(Path path)` Start building a Path from another name.
`static Path.Builder`	`from(Path path, int startIdx, int endIdx)` Start building a Path from another name.
`static Path.Builder`	`fromAttr(String attr)` Start building a Path from an initial attribute.
`Path`	`head(int toIndex)`
`long`	`index(int i)`
`static Path.Builder`	`newBuilder()`
`Path.NodeType`	`nodeType(int i)`
`static Path`	`of(ReaderCursor c)` Create a path from a ReaderCursor.
`static Path`	`of(String path)` Create a new path from a String.
`static Path`	`ofAttr(String attr)` Create a new path from the specific attribute.
`int`	`size()`
`boolean`	`startsWith(Path other)`
`Path`	`tail(int size)`
`Path`	`tailFrom(int fromIndex)`

- Method Detail
  - empty
```
static Path empty()
```
    Returns:
    
    An empty name.
  - of
```
static Path of(ReaderCursor c)
```
    Create a path from a ReaderCursor.
  - of
```
static Path of(String path)
```
    Create a new path from a String. Expect to works with the output of toString.
  - ofAttr
```
static Path ofAttr(String attr)
```
    Create a new path from the specific attribute.
  - fromAttr
```
static Path.Builder fromAttr(String attr)
```
    Start building a Path from an initial attribute.
    
    Returns:
    
    A builder.
  - from
```
static Path.Builder from(Path path)
```
    Start building a Path from another name.
  - from
```
static Path.Builder from(Path path,
                         int startIdx,
                         int endIdx)
```
    Start building a Path from another name.
  - newBuilder
```
static Path.Builder newBuilder()
```
    Returns:
    
    A new builder instance.
  - size
```
int size()
```
    Returns:
    
    The number of nodes in the path.
  - nodeType
```
Path.NodeType nodeType(int i)
```
    Returns:
    
    The type of node at the specified index.
  - attr
```
String attr(int i)
```
    Returns:
    
    The attribute node at the specified index.
  - index
```
long index(int i)
```
    Returns:
    
    The index node at the specified index.
  - head
```
Path head(int toIndex)
```
    Parameters:
    
    toIndex - the number of nodes to return.
    
    Returns:
    
    The head of the path up to toIndex nodes.
    
    Throws:
    
    IndexOutOfBoundsException - if toIndex > than size.
  - tail
```
Path tail(int size)
```
    Parameters:
    
    size - the number of segments to return.
    
    Returns:
    
    The head of the fully qualified name up to count segment.
    
    Throws:
    
    IndexOutOfBoundsException - if size > than fqn size.
  - tailFrom
```
Path tailFrom(int fromIndex)
```
    Parameters:
    
    fromIndex - the index of the starting segment.
    
    Returns:
    
    The tail of the fully qualified name starting at fromIndex.
    
    Throws:
    
    IndexOutOfBoundsException - if fromIndex > than size.
  - startsWith
```
boolean startsWith(Path other)
```
    Returns:
    
    Test if a name starts with another.
  - append
```
Path append(Path toAppend)
```
    Returns:
    
    @return A path containing the current path with another appended.
  - append
```
Path append(String toAppend)
```
    Returns:
    
    @return A path containing the current path with another appended.

Interface Path

Nested Class Summary

Method Summary

Method Detail

empty

of

of

ofAttr

fromAttr

from

from

newBuilder

size

nodeType

attr

index

head

tail

tailFrom

startsWith

append

append