Class FileIDFactory
- java.lang.Object
-
- org.eclipse.ecf.filetransfer.identity.FileIDFactory
-
- All Implemented Interfaces:
IFileIDFactory
public class FileIDFactory extends Object implements IFileIDFactory
Factory class entry point for creating IFileID instances.
-
-
Field Summary
Fields Modifier and Type Field Description protected static FileIDFactory
instance
-
Constructor Summary
Constructors Constructor Description FileIDFactory()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description IFileID
createFileID(Namespace namespace, Object[] arguments)
Create an IFileID from a Namespace and a String.IFileID
createFileID(Namespace namespace, String remoteFile)
Create an IFileID from a Namespace and a String.IFileID
createFileID(Namespace namespace, URI remoteFile)
Create an IFileID from a Namespace and a String.IFileID
createFileID(Namespace namespace, URL remoteFile)
Create an IFileID from a Namespace and a String.static FileIDFactory
getDefault()
Get singleton instance
-
-
-
Field Detail
-
instance
protected static FileIDFactory instance
-
-
Method Detail
-
getDefault
public static FileIDFactory getDefault()
Get singleton instance- Returns:
- FileIDFactory singleton instance. Will not be
null
. - Since:
- 5.0
-
createFileID
public IFileID createFileID(Namespace namespace, URL remoteFile) throws FileCreateException
Create an IFileID from a Namespace and a String.- Specified by:
createFileID
in interfaceIFileIDFactory
- Parameters:
namespace
- the namespace to use to create the IFileID. Can useIRetrieveFileTransferContainerAdapter.getRetrieveNamespace()
. Must not benull
.remoteFile
- the remote filename to use. Must not benull
.- Returns:
- IFileID instance. Will not return
null
. - Throws:
FileCreateException
- thrown if some problem creating IFileID from given namespace and filename
-
createFileID
public IFileID createFileID(Namespace namespace, String remoteFile) throws FileCreateException
Create an IFileID from a Namespace and a String.- Specified by:
createFileID
in interfaceIFileIDFactory
- Parameters:
namespace
- the namespace to use to create the IFileID. Can useIRetrieveFileTransferContainerAdapter.getRetrieveNamespace()
. Must not be null.remoteFile
- the remote filename to use. Must not benull
.- Returns:
- IFileID instance. Will not return
null
. - Throws:
FileCreateException
- thrown if some problem creating IFileID from given namespace and filename
-
createFileID
public IFileID createFileID(Namespace namespace, URI remoteFile) throws FileCreateException
Create an IFileID from a Namespace and a String.- Specified by:
createFileID
in interfaceIFileIDFactory
- Parameters:
namespace
- the namespace to use to create the IFileID. Can useIRetrieveFileTransferContainerAdapter.getRetrieveNamespace()
. Must not be null.remoteFile
- the remote resource identifier to use. Must not benull
.- Returns:
- IFileID instance. Will not return
null
. - Throws:
FileCreateException
- thrown if some problem creating IFileID from given namespace and filename- Since:
- 5.0
-
createFileID
public IFileID createFileID(Namespace namespace, Object[] arguments) throws FileCreateException
Create an IFileID from a Namespace and a String.- Specified by:
createFileID
in interfaceIFileIDFactory
- Parameters:
namespace
- the namespace to use to create the IFileID. Can useIRetrieveFileTransferContainerAdapter.getRetrieveNamespace()
. Must not benull
.arguments
- Object [] of arguments to use to create file ID. These arguments will be passed to theNamespace.createInstance(Object[])
method of the appropriate Namespace setup by the provider- Returns:
- IFileID instance. Will not return
null
. - Throws:
FileCreateException
- thrown if some problem creating IFileID from given namespace and filename
-
-