org.eclipse.remote.internal.core

Class RemotePath

java.lang.Object

org.eclipse.remote.internal.core.RemotePath

All Implemented Interfaces:

java.lang.Cloneable, org.eclipse.core.runtime.IPath

public class RemotePath
extends java.lang.Object
implements org.eclipse.core.runtime.IPath, java.lang.Cloneable

The Eclipse Mars implementation of org.eclipse.core.runtime.Path. Cloned from org.eclipse.equinox.common. This class should be removed when Eclipse older than Mars no longer needs to be supported.

See Also:

Path

Field Summary

Fields

Modifier and Type	Field and Description
static RemotePath	EMPTY Constant value containing the empty path with no device on the local file system.
static RemotePath	ROOT Constant value containing the root path with no device on the local file system.

Fields inherited from interface org.eclipse.core.runtime.IPath

DEVICE_SEPARATOR, SEPARATOR

Constructor Summary

Constructors

Constructor and Description
RemotePath(java.lang.String fullPath) Constructs a new path from the given string path.
RemotePath(java.lang.String device, java.lang.String path) Constructs a new path from the given device id and string path.

Method Summary

Modifier and Type	Method and Description
org.eclipse.core.runtime.IPath	addFileExtension(java.lang.String extension)
org.eclipse.core.runtime.IPath	addTrailingSeparator()
org.eclipse.core.runtime.IPath	append(org.eclipse.core.runtime.IPath tail)
org.eclipse.core.runtime.IPath	append(java.lang.String tail)
java.lang.Object	clone()
boolean	equals(java.lang.Object obj)
static RemotePath	forPosix(java.lang.String fullPath) Constructs a new POSIX path from the given string path.
static RemotePath	forWindows(java.lang.String fullPath) Constructs a new Windows path from the given string path.
static org.eclipse.core.runtime.IPath	fromOSString(java.lang.String pathString) Constructs a new path from the given string path.
static org.eclipse.core.runtime.IPath	fromPortableString(java.lang.String pathString) Constructs a new path from the given path string.
java.lang.String	getDevice()
java.lang.String	getFileExtension()
int	hashCode()
boolean	hasTrailingSeparator()
boolean	isAbsolute()
boolean	isEmpty()
boolean	isPrefixOf(org.eclipse.core.runtime.IPath anotherPath)
boolean	isRoot()
boolean	isUNC()
boolean	isValidPath(java.lang.String path)
static boolean	isValidPosixPath(java.lang.String path) Returns whether the given string is syntactically correct as a path on a POSIX file system.
static boolean	isValidPosixSegment(java.lang.String segment) Returns whether the given string is valid as a segment in a path on a POSIX file system.
boolean	isValidSegment(java.lang.String segment)
static boolean	isValidWindowsPath(java.lang.String path) Returns whether the given string is syntactically correct as a path on the Windows file system.
static boolean	isValidWindowsSegment(java.lang.String segment) Returns whether the given string is valid as a segment in a path on the Windows file system.
java.lang.String	lastSegment()
org.eclipse.core.runtime.IPath	makeAbsolute()
org.eclipse.core.runtime.IPath	makeRelative()
org.eclipse.core.runtime.IPath	makeRelativeTo(org.eclipse.core.runtime.IPath base)
org.eclipse.core.runtime.IPath	makeUNC(boolean toUNC)
int	matchingFirstSegments(org.eclipse.core.runtime.IPath anotherPath)
org.eclipse.core.runtime.IPath	removeFileExtension()
org.eclipse.core.runtime.IPath	removeFirstSegments(int count)
org.eclipse.core.runtime.IPath	removeLastSegments(int count)
org.eclipse.core.runtime.IPath	removeTrailingSeparator()
java.lang.String	segment(int index)
int	segmentCount()
java.lang.String[]	segments()
org.eclipse.core.runtime.IPath	setDevice(java.lang.String value)
java.io.File	toFile()
java.lang.String	toOSString()
java.lang.String	toPortableString()
java.lang.String	toString()
org.eclipse.core.runtime.IPath	uptoSegment(int count)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final RemotePath EMPTY

Constant value containing the empty path with no device on the local file system.

ROOT

public static final RemotePath ROOT

Constant value containing the root path with no device on the local file system.

Constructor Detail

RemotePath

public RemotePath(java.lang.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). This constructor should be used if the string path if for the local file system.

Parameters:

fullPath - the string path

See Also:

isValidPath(String)

RemotePath

public RemotePath(java.lang.String device,
                  java.lang.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)

Method Detail

fromOSString

public static org.eclipse.core.runtime.IPath fromOSString(java.lang.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

Since:

3.1

See Also:

IPath.toPortableString()

fromPortableString

public static org.eclipse.core.runtime.IPath fromPortableString(java.lang.String pathString)

Constructs a new path from the given path string. The path string must have been produced by a previous call to IPath.toPortableString.

Parameters:

pathString - the portable path string

Since:

3.1

See Also:

IPath.toPortableString()

forPosix

public static RemotePath forPosix(java.lang.String fullPath)

Constructs a new POSIX path from the given string path. The string path must represent a valid file system path on a POSIX 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. This factory method should be used if the string path is for a POSIX file system.

Parameters:

fullPath - the string path

Since:

3.7

See Also:

isValidPosixPath(String)

forWindows

public static RemotePath forWindows(java.lang.String fullPath)

Constructs a new Windows path from the given string path. The string path must represent a valid file system path on the Windows 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 Windows file system are also respected. This factory method should be used if the string path is for the Windows file system.

Parameters:

fullPath - the string path

Since:

3.7

See Also:

isValidWindowsPath(String)

addFileExtension

public org.eclipse.core.runtime.IPath addFileExtension(java.lang.String extension)

Specified by:

addFileExtension in interface org.eclipse.core.runtime.IPath

addTrailingSeparator

public org.eclipse.core.runtime.IPath addTrailingSeparator()

Specified by:

addTrailingSeparator in interface org.eclipse.core.runtime.IPath

append

public org.eclipse.core.runtime.IPath append(org.eclipse.core.runtime.IPath tail)

Specified by:

append in interface org.eclipse.core.runtime.IPath

append

public org.eclipse.core.runtime.IPath append(java.lang.String tail)

Specified by:

append in interface org.eclipse.core.runtime.IPath

clone

public java.lang.Object clone()

Specified by:

clone in interface org.eclipse.core.runtime.IPath

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface org.eclipse.core.runtime.IPath

Overrides:

equals in class java.lang.Object

getDevice

public java.lang.String getDevice()

Specified by:

getDevice in interface org.eclipse.core.runtime.IPath

getFileExtension

public java.lang.String getFileExtension()

Specified by:

getFileExtension in interface org.eclipse.core.runtime.IPath

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

hasTrailingSeparator

public boolean hasTrailingSeparator()

Specified by:

hasTrailingSeparator in interface org.eclipse.core.runtime.IPath

isAbsolute

public boolean isAbsolute()

Specified by:

isAbsolute in interface org.eclipse.core.runtime.IPath

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.eclipse.core.runtime.IPath

isPrefixOf

public boolean isPrefixOf(org.eclipse.core.runtime.IPath anotherPath)

Specified by:

isPrefixOf in interface org.eclipse.core.runtime.IPath

isRoot

public boolean isRoot()

Specified by:

isRoot in interface org.eclipse.core.runtime.IPath

isUNC

public boolean isUNC()

Specified by:

isUNC in interface org.eclipse.core.runtime.IPath

isValidPath

public boolean isValidPath(java.lang.String path)

Specified by:

isValidPath in interface org.eclipse.core.runtime.IPath

isValidPosixPath

public static boolean isValidPosixPath(java.lang.String path)

Returns whether the given string is syntactically correct as a path on a POSIX file system. The path is correct if each of the segments in its canonicalized form is valid.

Parameters:

path - the path to check

Returns:

true if the given string is a valid path, and false otherwise

Since:

3.7

See Also:

isValidPosixSegment(String)

isValidWindowsPath

public static boolean isValidWindowsPath(java.lang.String path)

Returns whether the given string is syntactically correct as a path on the Windows file system. The device id is the prefix up to and including the device separator (':'); the path proper is everything to the right of it, or the entire string if there is no device separator. The device id is not checked for validity; the path proper is correct if each of the segments in its canonicalized form is valid.

Parameters:

path - the path to check

Returns:

true if the given string is a valid path, and false otherwise

Since:

3.7

See Also:

isValidWindowsSegment(String)

isValidSegment

public boolean isValidSegment(java.lang.String segment)

Specified by:

isValidSegment in interface org.eclipse.core.runtime.IPath

isValidPosixSegment

public static boolean isValidPosixSegment(java.lang.String segment)

Returns whether the given string is valid as a segment in a path on a POSIX file system. The rules for valid segments are as follows:

• the empty string is not valid
• any string containing the slash character ('/') is not valid

Parameters:

segment - the path segment to check

Returns:

true if the given path segment is valid, and false otherwise

Since:

3.7

isValidWindowsSegment

public static boolean isValidWindowsSegment(java.lang.String segment)

Returns whether the given string is valid as a segment in a path on the Windows file system. The rules for valid segments are as follows:

• the empty string is not valid
• any string containing the slash character ('/') is not valid
• any string containing segment ('\') or device (':') separator characters is not valid

Parameters:

segment - the path segment to check

Returns:

true if the given path segment is valid, and false otherwise

Since:

3.7

lastSegment

public java.lang.String lastSegment()

Specified by:

lastSegment in interface org.eclipse.core.runtime.IPath

makeAbsolute

public org.eclipse.core.runtime.IPath makeAbsolute()

Specified by:

makeAbsolute in interface org.eclipse.core.runtime.IPath

makeRelative

public org.eclipse.core.runtime.IPath makeRelative()

Specified by:

makeRelative in interface org.eclipse.core.runtime.IPath

makeRelativeTo

public org.eclipse.core.runtime.IPath makeRelativeTo(org.eclipse.core.runtime.IPath base)

Specified by:

makeRelativeTo in interface org.eclipse.core.runtime.IPath

Since:

org.eclipse.equinox.common 3.5

makeUNC

public org.eclipse.core.runtime.IPath makeUNC(boolean toUNC)

Specified by:

makeUNC in interface org.eclipse.core.runtime.IPath

matchingFirstSegments

public int matchingFirstSegments(org.eclipse.core.runtime.IPath anotherPath)

Specified by:

matchingFirstSegments in interface org.eclipse.core.runtime.IPath

removeFileExtension

public org.eclipse.core.runtime.IPath removeFileExtension()

Specified by:

removeFileExtension in interface org.eclipse.core.runtime.IPath

removeFirstSegments

public org.eclipse.core.runtime.IPath removeFirstSegments(int count)

Specified by:

removeFirstSegments in interface org.eclipse.core.runtime.IPath

removeLastSegments

public org.eclipse.core.runtime.IPath removeLastSegments(int count)

Specified by:

removeLastSegments in interface org.eclipse.core.runtime.IPath

removeTrailingSeparator

public org.eclipse.core.runtime.IPath removeTrailingSeparator()

Specified by:

removeTrailingSeparator in interface org.eclipse.core.runtime.IPath

segment

public java.lang.String segment(int index)

Specified by:

segment in interface org.eclipse.core.runtime.IPath

segmentCount

public int segmentCount()

Specified by:

segmentCount in interface org.eclipse.core.runtime.IPath

segments

public java.lang.String[] segments()

Specified by:

segments in interface org.eclipse.core.runtime.IPath

setDevice

public org.eclipse.core.runtime.IPath setDevice(java.lang.String value)

Specified by:

setDevice in interface org.eclipse.core.runtime.IPath

toFile

public java.io.File toFile()

Specified by:

toFile in interface org.eclipse.core.runtime.IPath

toOSString

public java.lang.String toOSString()

Specified by:

toOSString in interface org.eclipse.core.runtime.IPath

toPortableString

public java.lang.String toPortableString()

Specified by:

toPortableString in interface org.eclipse.core.runtime.IPath

toString

public java.lang.String toString()

Specified by:

toString in interface org.eclipse.core.runtime.IPath

Overrides:

toString in class java.lang.Object

uptoSegment

public org.eclipse.core.runtime.IPath uptoSegment(int count)

Specified by:

uptoSegment in interface org.eclipse.core.runtime.IPath