ForwardRelativePath (Buck)

java.lang.Object
- com.facebook.buck.core.path.ForwardRelativePath

All Implemented Interfaces:

Comparable<ForwardRelativePath>
```
public class ForwardRelativePath
extends Object
implements Comparable<ForwardRelativePath>
```
A normalized relative path object which:
- Does not contain dot or dot-dot
- Does not start and does not end with slash
- Does not contain slash-slash

Field Summary

Fields
Modifier and Type Field and Description

static ForwardRelativePath EMPTY

Fields
Modifier and Type	Field and Description
`static ForwardRelativePath`	`EMPTY`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(ForwardRelativePath that)`
`boolean`	`endsWith(ForwardRelativePath path)` This path ends with given path.
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`Optional<ForwardRelativePath>`	`nameAsPath()` Last segment of path
`static ForwardRelativePath`	`of(String path)` Parse a string into path.
`static ForwardRelativePath`	`ofPath(Path path)` Construct from given relative `Path`.
`static ForwardRelativePath`	`ofSubstring(String path, int offset)` Parse a string into path removing .
`Optional<ForwardRelativePath>`	`parent()` Path without last segment
`String`	`relativize(ForwardRelativePath other)` Constructs a relative path between this path and a given path.
`ForwardRelativePath`	`resolve(ForwardRelativePath other)` Append given path to the current path
`ForwardRelativePath`	`resolve(String other)`
`com.google.common.collect.ImmutableList<String>`	`segments()`
`boolean`	`startsWith(ForwardRelativePath path)` This path starts with given path.
`Path`	`toPath(FileSystem fileSystem)` Convert file path to a relative path in given filesystem.
`Path`	`toPathDefaultFileSystem()` Convert this path to the `Path` of `FileSystems.getDefault()`.
`String`	`toPathPrefix()` A string to be prepended to another path to make a relative path
`RelPath`	`toRelPath(FileSystem fileSystem)`
`String`	`toString()`

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

- Field Detail
  - EMPTY
```
public static final ForwardRelativePath EMPTY
```
- Method Detail
  - of
```
public static ForwardRelativePath of(String path)
```
    Parse a string into path.
    This function throws if path is not normalized (e. g. contains two consecutive slashes).
  - ofSubstring
```
public static ForwardRelativePath ofSubstring(String path,
                                              int offset)
```
    Parse a string into path removing .
    This function throws if path is not normalized (e. g. contains two consecutive slashes).
    
    Parameters:
    
    offset - is the number of characters to be removed from the path before parsing (useful in certain cases to avoid extra string allocation).
  - ofPath
```
public static ForwardRelativePath ofPath(Path path)
```
    Construct from given relative Path.
    This functions calls Path.normalize(). Throw if path is not relative.
  - resolve
```
public ForwardRelativePath resolve(ForwardRelativePath other)
```
    Append given path to the current path
  - resolve
```
public ForwardRelativePath resolve(String other)
```
  - isEmpty
```
public boolean isEmpty()
```
  - toPath
```
public Path toPath(FileSystem fileSystem)
```
    Convert file path to a relative path in given filesystem.
    Note this function is optimized for BuckFileSystem (avoids re-parsing and re-interning).
  - toPathDefaultFileSystem
```
public Path toPathDefaultFileSystem()
```
    Convert this path to the Path of FileSystems.getDefault().
  - toRelPath
```
public RelPath toRelPath(FileSystem fileSystem)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - nameAsPath
```
public Optional<ForwardRelativePath> nameAsPath()
```
    Last segment of path
  - parent
```
public Optional<ForwardRelativePath> parent()
```
    Path without last segment
  - toPathPrefix
```
public String toPathPrefix()
```
    A string to be prepended to another path to make a relative path
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - startsWith
```
public boolean startsWith(ForwardRelativePath path)
```
    This path starts with given path.
    ab/cd starts with ab/cd, ab, but not ab/c.
  - endsWith
```
public boolean endsWith(ForwardRelativePath path)
```
    This path ends with given path.
    ab/cd ends with ab/cd, cd, but not b/cd.
  - segments
```
public com.google.common.collect.ImmutableList<String> segments()
```
  - relativize
```
public String relativize(ForwardRelativePath other)
```
    Constructs a relative path between this path and a given path.
    Returns empty string when paths are equal.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(ForwardRelativePath that)
```
    Specified by:
    
    compareTo in interface Comparable<ForwardRelativePath>

Class ForwardRelativePath

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

Method Detail

of

ofSubstring

ofPath

resolve

resolve

isEmpty

toPath

toPathDefaultFileSystem

toRelPath

toString

nameAsPath

parent

toPathPrefix

equals

startsWith

endsWith

segments

relativize

hashCode

compareTo