org.eclipse.ptp.rdt.sync.core

Class RemoteLocation

java.lang.Object

org.eclipse.ptp.rdt.sync.core.RemoteLocation

public class RemoteLocation
extends java.lang.Object

Class for defining and handling a "remote location" (primarily a host and directory pair) Equality is also well-defined so that the class is useful for indexing.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
RemoteLocation() Create new RemoteLocation object with all values set to null.
RemoteLocation(RemoteLocation rl) Copy constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
IRemoteConnection	getConnection() Get remote connection.
java.lang.String	getConnectionName() Get name of connection to remote
java.lang.String	getConnectionTypeId() Get the connection type ID
java.lang.String	getDirectory() Get the raw remote location unresolved
java.lang.String	getDirectory(org.eclipse.core.resources.IProject project) Get location (directory), resolved in terms of the passed project
int	hashCode()
static java.lang.String	resolveString(org.eclipse.core.resources.IProject project, java.lang.String path) Utility function to resolve a string based on path variables for a certain project.
void	setConnection(IRemoteConnection connection) Set the remote connection
void	setConnectionName(java.lang.String connectionName) Set the connection name
void	setConnectionTypeId(java.lang.String connectionTypeId) Set the connection type ID
void	setLocation(java.lang.String location) Set the sync location

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteLocation

public RemoteLocation()

Create new RemoteLocation object with all values set to null. Clients should use setters to finish creating object.

RemoteLocation

public RemoteLocation(RemoteLocation rl)

Copy constructor

Parameters:

rl - remote location to copy - cannot be null

Method Detail

resolveString

public static java.lang.String resolveString(org.eclipse.core.resources.IProject project,
                                             java.lang.String path)

Utility function to resolve a string based on path variables for a certain project. Unless string is in the form: ${path_variable:/remainder}, where "path_variable" is a path variable defined for the project, the original string is returned unchanged. The Eclipse platform should provide a standard mechanism for doing this, but various combinations of URIUtil and PathVariableManager methods failed.

Parameters:

project -

path -

Returns:

resolved string

getConnectionName

public java.lang.String getConnectionName()

Get name of connection to remote

Returns:

connection name

getDirectory

public java.lang.String getDirectory()

Get the raw remote location unresolved

Returns:

remote directory

getDirectory

public java.lang.String getDirectory(org.eclipse.core.resources.IProject project)

Get location (directory), resolved in terms of the passed project

Parameters:

project -

Returns:

remote directory

getConnection

public IRemoteConnection getConnection()
                                throws MissingConnectionException

Get remote connection. If connection is missing, this function calls the missing-connection handler. Thus, after catching the exception, callers can assume user has already been notified and given an opportunity to define the connection. So callers only need to worry about recovering gracefully.

Returns:

remote connection - never null

Throws:

MissingConnectionException - if no connection with the stored name exist. This can happen for various reasons: 1) The connection was renamed 2) The connection was deleted 3) The connection never existed, such as when a project is imported to a different workspace

getConnectionTypeId

public java.lang.String getConnectionTypeId()

Get the connection type ID

Returns:

connection type ID

Since:

5.0

setConnection

public void setConnection(IRemoteConnection connection)

Set the remote connection

Parameters:

connection -

setConnectionName

public void setConnectionName(java.lang.String connectionName)

Set the connection name

Parameters:

connectionName -

setLocation

public void setLocation(java.lang.String location)

Set the sync location

Parameters:

location -

setConnectionTypeId

public void setConnectionTypeId(java.lang.String connectionTypeId)

Set the connection type ID

Parameters:

connectionTypeId -

Since:

5.0

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object