Path (Generator 1.3.3 API)

java.lang.Object
- com.mulesoft.jaxrs.raml.annotation.model.Path

All Implemented Interfaces:

Cloneable
```
public class Path
extends Object
implements Cloneable
```
The standard implementation of the Path interface. Paths are always maintained in canonicalized form. That is, parent references (i.e., ../../) and duplicate separators are resolved. For example,
```
     new Path("/a/b").append("../foo/bar")
```
will yield the path
```
     /a/foo/bar
```
This class can be used without OSGi running.
This class is not intended to be subclassed by clients but may be instantiated.
Version:

$Id: $Id

Author:

kor

See Also:

Path

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`DEVICE_SEPARATOR` Device separator character constant ":" used in paths.
`static Path`	`EMPTY` Constant value containing the empty path with no device.
`static Path`	`ROOT` Constant value containing the root path with no device.
`static char`	`SEPARATOR` Path separator character constant "/" used in paths.

Constructor Summary

Constructors
Constructor and Description
`Path(String fullPath)` Constructs a new path from the given string path.
`Path(String device, String path)` Constructs a new path from the given device id and string path.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Path`	`addFileExtension(String extension)` addFileExtension.
`Path`	`addTrailingSeparator()` addTrailingSeparator.
`Path`	`append(Path tail)` append.
`Path`	`append(String tail)` append.
`Object`	`clone()` clone.
`boolean`	`equals(Object obj)`
`static Path`	`fromOSString(String pathString)` Constructs a new path from the given string path.
`static Path`	`fromPortableString(String pathString)` Constructs a new path from the given path string.
`String`	`getDevice()` Getter for the field `device`.
`String`	`getFileExtension()` getFileExtension.
`int`	`hashCode()` hashCode.
`boolean`	`hasTrailingSeparator()` hasTrailingSeparator.
`boolean`	`isAbsolute()` isAbsolute.
`boolean`	`isEmpty()` isEmpty.
`boolean`	`isPrefixOf(Path anotherPath)` isPrefixOf.
`boolean`	`isRoot()` isRoot.
`boolean`	`isUNC()` isUNC.
`boolean`	`isValidPath(String path)` isValidPath.
`boolean`	`isValidSegment(String segment)` isValidSegment.
`String`	`lastSegment()` lastSegment.
`Path`	`makeAbsolute()` makeAbsolute.
`Path`	`makeRelative()` makeRelative.
`Path`	`makeRelativeTo(Path base)`
`Path`	`makeUNC(boolean toUNC)` makeUNC.
`int`	`matchingFirstSegments(Path anotherPath)` matchingFirstSegments.
`Path`	`removeFileExtension()` removeFileExtension.
`Path`	`removeFirstSegments(int count)` removeFirstSegments.
`Path`	`removeLastSegments(int count)` removeLastSegments.
`Path`	`removeTrailingSeparator()` removeTrailingSeparator.
`String`	`segment(int index)` segment.
`int`	`segmentCount()` segmentCount.
`String[]`	`segments()` segments.
`Path`	`setDevice(String value)` Setter for the field `device`.
`File`	`toFile()` toFile.
`String`	`toOSString()` toOSString.
`String`	`toPortableString()` toPortableString.
`String`	`toString()` toString.
`Path`	`uptoSegment(int count)` uptoSegment.

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

- Field Detail
  - SEPARATOR
```
public static final char SEPARATOR
```
    Path separator character constant "/" used in paths.
    
    See Also:
    
    Constant Field Values
  - DEVICE_SEPARATOR
```
public static final char DEVICE_SEPARATOR
```
    Device separator character constant ":" used in paths.
    
    See Also:
    
    Constant Field Values
  - EMPTY
```
public static final Path EMPTY
```
    Constant value containing the empty path with no device.
  - ROOT
```
public static final Path ROOT
```
    Constant value containing the root path with no device.
- Constructor Detail
  - Path
```
public Path(String fullPath)
```
    Constructs a new path from the given string path. The string path must represent a valid file system path on the local file system. The path is canonicalized and double slashes are removed except at the beginning. (to handle UNC paths). All forward slashes ('/') are treated as segment delimiters, and any segment and device delimiters for the local file system are also respected (such as colon (':') and backslash ('\') on some file systems).
    
    Parameters:
    
    fullPath - the string path
    
    See Also:
    
    isValidPath(String)
  - Path
```
public Path(String device,
            String path)
```
    Constructs a new path from the given device id and string path. The given string path must be valid. The path is canonicalized and double slashes are removed except at the beginning (to handle UNC paths). All forward slashes ('/') are treated as segment delimiters, and any segment delimiters for the local file system are also respected (such as backslash ('\') on some file systems).
    
    Parameters:
    
    device - the device id
    
    path - the string path
    
    See Also:
    
    isValidPath(String), setDevice(String), isValidPath(String), setDevice(String)
- Method Detail
  - fromOSString
```
public static Path fromOSString(String pathString)
```
    Constructs a new path from the given string path. The string path must represent a valid file system path on the local file system. The path is canonicalized and double slashes are removed except at the beginning. (to handle UNC paths). All forward slashes ('/') are treated as segment delimiters, and any segment and device delimiters for the local file system are also respected.
    
    Parameters:
    
    pathString - the portable string path
    
    Returns:
    
    a Path object.
    
    Since:
    
    3.1
    
    See Also:
    
    toPortableString()
  - fromPortableString
```
public static Path fromPortableString(String pathString)
```
    Constructs a new path from the given path string. The path string must have been produced by a previous call to Path.toPortableString.
    
    Parameters:
    
    pathString - the portable path string
    
    Returns:
    
    a Path object.
    
    Since:
    
    3.1
    
    See Also:
    
    toPortableString()
  - addFileExtension
```
public Path addFileExtension(String extension)
```
    addFileExtension.
    
    Parameters:
    
    extension - a String object.
    
    Returns:
    
    a Path object.
  - addTrailingSeparator
```
public Path addTrailingSeparator()
```
    addTrailingSeparator.
    
    Returns:
    
    a Path object.
  - append
```
public Path append(Path tail)
```
    append.
    
    Parameters:
    
    tail - a Path object.
    
    Returns:
    
    a Path object.
  - append
```
public Path append(String tail)
```
    append.
    
    Parameters:
    
    tail - a String object.
    
    Returns:
    
    a Path object.
  - clone
```
public Object clone()
```
    clone.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a Object object.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getDevice
```
public String getDevice()
```
    Getter for the field device.
    
    Returns:
    
    a String object.
  - getFileExtension
```
public String getFileExtension()
```
    getFileExtension.
    
    Returns:
    
    a String object.
  - hashCode
```
public int hashCode()
```
    hashCode.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a int.
  - hasTrailingSeparator
```
public boolean hasTrailingSeparator()
```
    hasTrailingSeparator.
    
    Returns:
    
    a boolean.
  - isAbsolute
```
public boolean isAbsolute()
```
    isAbsolute.
    
    Returns:
    
    a boolean.
  - isEmpty
```
public boolean isEmpty()
```
    isEmpty.
    
    Returns:
    
    a boolean.
  - isPrefixOf
```
public boolean isPrefixOf(Path anotherPath)
```
    isPrefixOf.
    
    Parameters:
    
    anotherPath - a Path object.
    
    Returns:
    
    a boolean.
  - isRoot
```
public boolean isRoot()
```
    isRoot.
    
    Returns:
    
    a boolean.
  - isUNC
```
public boolean isUNC()
```
    isUNC.
    
    Returns:
    
    a boolean.
  - isValidPath
```
public boolean isValidPath(String path)
```
    isValidPath.
    
    Parameters:
    
    path - a String object.
    
    Returns:
    
    a boolean.
  - isValidSegment
```
public boolean isValidSegment(String segment)
```
    isValidSegment.
    
    Parameters:
    
    segment - a String object.
    
    Returns:
    
    a boolean.
  - lastSegment
```
public String lastSegment()
```
    lastSegment.
    
    Returns:
    
    a String object.
  - makeAbsolute
```
public Path makeAbsolute()
```
    makeAbsolute.
    
    Returns:
    
    a Path object.
  - makeRelative
```
public Path makeRelative()
```
    makeRelative.
    
    Returns:
    
    a Path object.
  - makeRelativeTo
```
public Path makeRelativeTo(Path base)
```
    Parameters:
    
    base - a Path object.
    
    Returns:
    
    a Path object.
    
    Since:
    
    org.eclipse.equinox.common 3.5
  - makeUNC
```
public Path makeUNC(boolean toUNC)
```
    makeUNC.
    
    Parameters:
    
    toUNC - a boolean.
    
    Returns:
    
    a Path object.
  - matchingFirstSegments
```
public int matchingFirstSegments(Path anotherPath)
```
    matchingFirstSegments.
    
    Parameters:
    
    anotherPath - a Path object.
    
    Returns:
    
    a int.
  - removeFileExtension
```
public Path removeFileExtension()
```
    removeFileExtension.
    
    Returns:
    
    a Path object.
  - removeFirstSegments
```
public Path removeFirstSegments(int count)
```
    removeFirstSegments.
    
    Parameters:
    
    count - a int.
    
    Returns:
    
    a Path object.
  - removeLastSegments
```
public Path removeLastSegments(int count)
```
    removeLastSegments.
    
    Parameters:
    
    count - a int.
    
    Returns:
    
    a Path object.
  - removeTrailingSeparator
```
public Path removeTrailingSeparator()
```
    removeTrailingSeparator.
    
    Returns:
    
    a Path object.
  - segment
```
public String segment(int index)
```
    segment.
    
    Parameters:
    
    index - a int.
    
    Returns:
    
    a String object.
  - segmentCount
```
public int segmentCount()
```
    segmentCount.
    
    Returns:
    
    a int.
  - segments
```
public String[] segments()
```
    segments.
    
    Returns:
    
    an array of String objects.
  - setDevice
```
public Path setDevice(String value)
```
    Setter for the field device.
    
    Parameters:
    
    value - a String object.
    
    Returns:
    
    a Path object.
  - toFile
```
public File toFile()
```
    toFile.
    
    Returns:
    
    a File object.
  - toOSString
```
public String toOSString()
```
    toOSString.
    
    Returns:
    
    a String object.
  - toPortableString
```
public String toPortableString()
```
    toPortableString.
    
    Returns:
    
    a String object.
  - toString
```
public String toString()
```
    toString.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a String object.
  - uptoSegment
```
public Path uptoSegment(int count)
```
    uptoSegment.
    
    Parameters:
    
    count - a int.
    
    Returns:
    
    a Path object.

Class Path

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SEPARATOR

DEVICE_SEPARATOR

EMPTY

ROOT

Constructor Detail

Path

Path

Method Detail

fromOSString

fromPortableString

addFileExtension

addTrailingSeparator

append

append

clone

equals

getDevice

getFileExtension

hashCode

hasTrailingSeparator

isAbsolute

isEmpty

isPrefixOf

isRoot

isUNC

isValidPath

isValidSegment

lastSegment

makeAbsolute

makeRelative

makeRelativeTo

makeUNC

matchingFirstSegments

removeFileExtension

removeFirstSegments

removeLastSegments

removeTrailingSeparator

segment

segmentCount

segments

setDevice

toFile

toOSString

toPortableString

toString

uptoSegment