ImmutableListPathCore (Giraffe 0.9.0)

java.lang.Object
- com.palantir.giraffe.file.base.ImmutableListPathCore

All Implemented Interfaces:

PathCore<ImmutableListPathCore>, Comparable<ImmutableListPathCore>
```
public final class ImmutableListPathCore
extends Object
implements PathCore<ImmutableListPathCore>
```
A PathCore implementation backed by an ImmutableList of segments.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableListPathCore.Parser
Creates ImmutableListPathCore instances from path strings.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableListPathCore.Parser` Creates `ImmutableListPathCore` instances from path strings.

Constructor Summary

Constructors
Constructor and Description

ImmutableListPathCore(String root, Iterable<String> path)
Constructs a new core instance.

Constructors
Constructor and Description
`ImmutableListPathCore(String root, Iterable<String> path)` Constructs a new core instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(ImmutableListPathCore other)`
`boolean`	`endsWith(ImmutableListPathCore other)`
`boolean`	`equals(Object obj)`
`ImmutableListPathCore`	`getFileName()`
`ImmutableListPathCore`	`getName(int index)`
`int`	`getNameCount()`
`ImmutableListPathCore`	`getParent()`
`ImmutableList<String>`	`getPathSegments()`
`ImmutableListPathCore`	`getRoot()`
`String`	`getRootString()` Returns the root component of this path, or `null` if this path is relative.
`int`	`hashCode()`
`boolean`	`isAbsolute()`
`static ImmutableListPathCore.Parser`	`namedRootParser(String separator, ImmutableListPathCore.Parser.NamedRootFormat format, String rootId)` Constructs a new parser for path strings with named roots.
`ImmutableListPathCore`	`normalize()`
`static ImmutableListPathCore.Parser`	`parser(String separator)` Constructs a new parser for path strings with a single root.
`ImmutableListPathCore`	`relativize(ImmutableListPathCore other)`
`ImmutableListPathCore`	`resolve(ImmutableListPathCore other)`
`ImmutableListPathCore`	`resolveSibling(ImmutableListPathCore other)`
`boolean`	`startsWith(ImmutableListPathCore other)`
`ImmutableListPathCore`	`subpath(int beginIndex, int endIndex)`
`String`	`toPathString(String separator)`
`String`	`toString()`

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

- Constructor Detail
  - ImmutableListPathCore
```
public ImmutableListPathCore(@Nullable
                             String root,
                             Iterable<String> path)
```
    Constructs a new core instance.
    
    Parameters:
    
    root - the root component, or null if this path is relative.
    
    path - the segments that make up this path
- Method Detail
  - parser
```
public static ImmutableListPathCore.Parser parser(String separator)
```
    Constructs a new parser for path strings with a single root. Each segment of the path is separated by the given string. Absolute paths start with the given string.
    
    Parameters:
    
    separator - the path separator
    
    Returns:
    
    a new parser
  - namedRootParser
```
public static ImmutableListPathCore.Parser namedRootParser(String separator,
                                                           ImmutableListPathCore.Parser.NamedRootFormat format,
                                                           String rootId)
```
    Constructs a new parser for path strings with named roots. Each segment of the path is separated by the given separator string.
    Roots are parsed based on the root format and the root identifier string. For prefix roots, absolute paths start with the identifier string. The root name consists of all characters from the start of the string to the first path separator, exclusive. For postfix roots, absolute paths contain the identifier string. The root name consists of all characters from the start of the string to the identifier, inclusive. The path separator must immediately follow the identifier.
    For optional prefix roots, absolute paths start with either the identifier string as described above or the path separator. Absolute paths that start with the path separator have an unnamed (empty) root.
    
    Parameters:
    
    separator - the path separator
    
    format - the root format
    
    rootId - the root identifier
    
    Returns:
    
    a new parser
  - isAbsolute
```
public boolean isAbsolute()
```
    Specified by:
    
    isAbsolute in interface PathCore<ImmutableListPathCore>
  - getRoot
```
public ImmutableListPathCore getRoot()
```
    Specified by:
    
    getRoot in interface PathCore<ImmutableListPathCore>
  - getFileName
```
public ImmutableListPathCore getFileName()
```
    Specified by:
    
    getFileName in interface PathCore<ImmutableListPathCore>
  - getParent
```
public ImmutableListPathCore getParent()
```
    Specified by:
    
    getParent in interface PathCore<ImmutableListPathCore>
  - getNameCount
```
public int getNameCount()
```
    Specified by:
    
    getNameCount in interface PathCore<ImmutableListPathCore>
  - getName
```
public ImmutableListPathCore getName(int index)
```
    Specified by:
    
    getName in interface PathCore<ImmutableListPathCore>
  - subpath
```
public ImmutableListPathCore subpath(int beginIndex,
                                     int endIndex)
```
    Specified by:
    
    subpath in interface PathCore<ImmutableListPathCore>
  - startsWith
```
public boolean startsWith(ImmutableListPathCore other)
```
    Specified by:
    
    startsWith in interface PathCore<ImmutableListPathCore>
  - endsWith
```
public boolean endsWith(ImmutableListPathCore other)
```
    Specified by:
    
    endsWith in interface PathCore<ImmutableListPathCore>
  - normalize
```
public ImmutableListPathCore normalize()
```
    Specified by:
    
    normalize in interface PathCore<ImmutableListPathCore>
  - resolve
```
public ImmutableListPathCore resolve(ImmutableListPathCore other)
```
    Specified by:
    
    resolve in interface PathCore<ImmutableListPathCore>
  - resolveSibling
```
public ImmutableListPathCore resolveSibling(ImmutableListPathCore other)
```
    Specified by:
    
    resolveSibling in interface PathCore<ImmutableListPathCore>
  - relativize
```
public ImmutableListPathCore relativize(ImmutableListPathCore other)
```
    Specified by:
    
    relativize in interface PathCore<ImmutableListPathCore>
  - toPathString
```
public String toPathString(String separator)
```
    Specified by:
    
    toPathString in interface PathCore<ImmutableListPathCore>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(ImmutableListPathCore other)
```
    Specified by:
    
    compareTo in interface Comparable<ImmutableListPathCore>
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getRootString
```
@Nullable
public String getRootString()
```
    Returns the root component of this path, or null if this path is relative.
  - getPathSegments
```
public ImmutableList<String> getPathSegments()
```

Class ImmutableListPathCore

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImmutableListPathCore

Method Detail

parser

namedRootParser

isAbsolute

getRoot

getFileName

getParent

getNameCount

getName

subpath

startsWith

endsWith

normalize

resolve

resolveSibling

relativize

toPathString

toString

compareTo

equals

hashCode

getRootString

getPathSegments