Fqn (dbrain-data 0.19 API)

All Known Implementing Classes:

FqnImpl
```
public interface Fqn
```
Describe a fully qualified name. Syntax allows for wildcards as well as ways of escaping them. '' test test.'' test.123.'*' test.123.'**' test.123.'test*'

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface Fqn.Builder
Builder interface for the Fqn.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Fqn.Builder` Builder interface for the Fqn.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Fqn`	`empty()`
`static Fqn.Builder`	`from(Fqn fqn)` Start building a Fqn from another name.
`static Fqn.Builder`	`fromSegment(String segment)` Start building a Fqn from an initial segment.
`Fqn`	`head(int toIndex)`
`static Fqn.Builder`	`newBuilder()`
`static Fqn`	`of(ReaderCursor c)` Create a fully qualified name from a ReaderCursor.
`static Fqn`	`of(String fqn)` Create a new Fully Qualified Name from a String.
`static Fqn`	`ofSegment(String segment)`
`String`	`segment(int i)`
`int`	`size()`
`boolean`	`startsWith(Fqn other)`
`Fqn`	`tail(int size)`
`Fqn`	`tailFrom(int fromIndex)`

- Method Detail
  - empty
```
static Fqn empty()
```
    Returns:
    
    An empty name.
  - of
```
static Fqn of(ReaderCursor c)
```
    Create a fully qualified name from a ReaderCursor.
  - of
```
static Fqn of(String fqn)
```
    Create a new Fully Qualified Name from a String. Expect to works with the output of toString.
  - ofSegment
```
static Fqn ofSegment(String segment)
```
  - fromSegment
```
static Fqn.Builder fromSegment(String segment)
```
    Start building a Fqn from an initial segment.
    
    Returns:
    
    A builder.
  - from
```
static Fqn.Builder from(Fqn fqn)
```
    Start building a Fqn from another name.
  - newBuilder
```
static Fqn.Builder newBuilder()
```
    Returns:
    
    A new builder instance.
  - size
```
int size()
```
    Returns:
    
    The number of segments in the name.
  - segment
```
String segment(int i)
```
    Returns:
    
    A single segment within the name.
  - head
```
Fqn head(int toIndex)
```
    Parameters:
    
    toIndex - the number of segments to return.
    
    Returns:
    
    The head of the fully qualified name up to toIndex segment.
    
    Throws:
    
    IndexOutOfBoundsException - if toIndex > than size.
  - tail
```
Fqn 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
```
Fqn 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(Fqn other)
```
    Returns:
    
    Test if a name starts with another.

Interface Fqn

Nested Class Summary

Method Summary

Method Detail

empty

of

of

ofSegment

fromSegment

from

newBuilder

size

segment

head

tail

tailFrom

startsWith