RSE
Release 3.4

org.eclipse.rse.subsystems.files.core.model
Interface IRemotePath


public interface IRemotePath

This interface represents a remote path.


Method Summary
 IRemotePath addFileExtension(String extension)
          Returns a new path with the file extension added to this path.
 String getAbsolutePath()
          Returns the absolute path.
 String getConnectionName()
          Returns the connection name.
 String getFileExtension()
          Returns the file extension for the path.
 String getFullyQualifiedPath()
          Returns the fully qualified path.
 String getProfileName()
          Returns the profile name.
 boolean isVirtual()
          Returns whether this path represents a virtual file.
 IRemotePath removeFileExtension()
          Returns a new path with the file extension removed from this path.
 IRemoteFile toRemoteFile()
          Returns the remote file represented by the remote path.
 

Method Detail

getProfileName

String getProfileName()
Returns the profile name.

Returns:
the profile name.

getConnectionName

String getConnectionName()
Returns the connection name.

Returns:
the connection name.

getAbsolutePath

String getAbsolutePath()
Returns the absolute path.

Returns:
the absolute path.

getFullyQualifiedPath

String getFullyQualifiedPath()
Returns the fully qualified path. The fully qualified path is the absolute path on the remote machine, prefixed by profile name and connection name. It is of the form "profileName.connectionName:absolutePath". If the profile name, connection name or absolute path is null, then the fully qualified path will also be null.

Returns:
the fully qualified path.

getFileExtension

String getFileExtension()
Returns the file extension for the path. The file extension portion is defined as the string following the last period (".") character in the path.

Returns:
the extension, or null if none.

addFileExtension

IRemotePath addFileExtension(String extension)
Returns a new path with the file extension added to this path. The file extension portion is defined as the string following the last period (".") character in the path. If this path ends with a separator, i.e. '/' or '\\', then this path is returned. The given extension should not include a leading ".".

Parameters:
extension - the file extension to append to the path.
Returns:
the new path.

removeFileExtension

IRemotePath removeFileExtension()
Returns a new path with the file extension removed from this path. The file extension portion is defined as the string following the last period (".") character in the path. If this path ends with a separator, i.e. '/' or '\\', or if it does not have an extension, then this path is returned. The given extension should not include a leading ".".

Returns:
path with the file extension removed.

isVirtual

boolean isVirtual()
Returns whether this path represents a virtual file.

Returns:
true if the path represents a virtual file, false otherwise.

toRemoteFile

IRemoteFile toRemoteFile()
Returns the remote file represented by the remote path.

Returns:
the remote file.

RSE
Release 3.4

Copyright (c) IBM Corporation and others 2000, 2012. All Rights Reserved.