org.eclipse.ecf.provider.filetransfer.identity
Class FileTransferNamespace

java.lang.Object
  extended by org.eclipse.ecf.core.identity.Namespace
      extended by org.eclipse.ecf.provider.filetransfer.identity.FileTransferNamespace
All Implemented Interfaces:
java.io.Serializable, org.eclipse.core.runtime.IAdaptable

public class FileTransferNamespace
extends Namespace

URL file namespace class. This defines a namespace that understands how to create IFileID instances from arbitary URLs

See Also:
Serialized Form

Field Summary
static java.lang.String PROTOCOL
           
 
Fields inherited from class org.eclipse.ecf.core.identity.Namespace
SCHEME_SEPARATOR
 
Constructor Summary
FileTransferNamespace()
           
 
Method Summary
 ID createInstance(java.lang.Object[] args)
          Make an instance of this namespace.
 java.lang.String getScheme()
          Get the primary scheme associated with this namespace.
 java.lang.Class[][] getSupportedParameterTypes()
          Get the supported parameter types for IDs created via subsequent calls to Namespace.createInstance(Object[]).
 java.lang.String[] getSupportedSchemes()
          Get an array of schemes supported by this Namespace instance.
 
Methods inherited from class org.eclipse.ecf.core.identity.Namespace
equals, getAdapter, getCompareToForObject, getDescription, getHashCodeForID, getInitStringFromExternalForm, getName, getNameForID, hashCode, initialize, testIDEquals, toExternalForm, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

PROTOCOL

public static final java.lang.String PROTOCOL
Constructor Detail

FileTransferNamespace

public FileTransferNamespace()
Method Detail

createInstance

public ID createInstance(java.lang.Object[] args)
                  throws IDCreateException
Description copied from class: Namespace
Make an instance of this namespace. Namespace subclasses, provided by plugins must implement this method to construct ID instances for the given namespace.

See Namespace.getSupportedParameterTypes() to get information relevant to deciding what parameter types are expected by this method.

Specified by:
createInstance in class Namespace
Parameters:
args - an Object[] of parameters for creating ID instances. May be null.
Returns:
a non-null ID instance. The class used may extend BaseID or may implement the ID interface directly
Throws:
IDCreateException - if construction fails

getSupportedSchemes

public java.lang.String[] getSupportedSchemes()
Description copied from class: Namespace
Get an array of schemes supported by this Namespace instance. Subclasses may override to support multiple schemes.

Overrides:
getSupportedSchemes in class Namespace
Returns:
String[] of schemes supported by this Namespace. Will not be null, but returned array may be of length 0.

getScheme

public java.lang.String getScheme()
Description copied from class: Namespace
Get the primary scheme associated with this namespace. Subclasses must provide an implementation that returns a non-null scheme identifier. Note that the returned scheme should not contain the Namespace.SCHEME_SEPARATOR (\":\").

Specified by:
getScheme in class Namespace
Returns:
a String scheme identifier. Must not be null.

getSupportedParameterTypes

public java.lang.Class[][] getSupportedParameterTypes()
Description copied from class: Namespace
Get the supported parameter types for IDs created via subsequent calls to Namespace.createInstance(Object[]). Callers may use this method to determine the available parameter types, and then create and pass in conforming Object arrays to to Namespace.createInstance(Object[]).

An empty two-dimensional array (new Class[0][0]) is the default returned by this abstract superclass. This means that the Object [] passed to Namespace.createInstance(Object[]) will be ignored.

Subsclasses should override this method to specify the parameters that they will accept in calls to Namespace.createInstance(Object[]). The rows of the returned Class array are the acceptable types for a given invocation of createInstance.

Consider the following example:

 public Class[][] getSupportedParameterTypes() {
        return new Class[][] { { String.class }, { String.class, String.class } };
 }
 
The above means that there are two acceptable values for the Object [] passed into Namespace.createInstance(Object[]): 1) a single String, and 2) two Strings. These would therefore be acceptable as input to createInstance:
        ID newID1 = namespace.createInstance(new Object[] { "Hello" });
        ID newID2 = namespace.createInstance(new Object[] { "Hello", "There"}};
 

Overrides:
getSupportedParameterTypes in class Namespace
Returns:
Class [][] an array of class []s. Rows of the returned two-dimensional array define the acceptable parameter types for a single call to Namespace.createInstance(Object[]). If zero-length Class arrays are returned (i.e. Class[0][0]), then Object [] parameters to Namespace.createInstance(Object[]) will be ignored.