de.intarsys.tools.locator
Class FileLocatorFactory

java.lang.Object
  extended by de.intarsys.tools.locator.FileLocatorFactory
All Implemented Interfaces:
ILocatorFactory

public class FileLocatorFactory
extends java.lang.Object
implements ILocatorFactory

The factory for FileLocator objects.

FileLocator instances are created either using an absolute path name or are looked up relative to the factorys search path. Multiple search paths may be defined.


Field Summary
static java.lang.String PATH_SEPARATOR
          The separator character for the definition of multiple search paths
 
Constructor Summary
FileLocatorFactory()
          Create a new factory.
 
Method Summary
 ILocator createLocator(java.lang.String path)
          The file locator factory supports looking up resources in multiple paths.
 java.lang.String getSearchPathDefinition()
           
 java.util.List getSearchPaths()
           
 boolean isSynchSynchronous()
           
 void setSearchPathDefinition(java.lang.String searchPath)
           
 void setSearchPaths(java.util.List searchPaths)
           
 void setSynchSynchronous(boolean synchSynchronous)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PATH_SEPARATOR

public static final java.lang.String PATH_SEPARATOR
The separator character for the definition of multiple search paths

See Also:
Constant Field Values
Constructor Detail

FileLocatorFactory

public FileLocatorFactory()
Create a new factory.

Method Detail

createLocator

public ILocator createLocator(java.lang.String path)
The file locator factory supports looking up resources in multiple paths. To preserve compatibility to ILocatorFactory, the last locator created is returned if no match is found. This is a valid locator, even so no existing physical resource is designated.

Specified by:
createLocator in interface ILocatorFactory
Parameters:
path - The fully qualified location definition.
Returns:
The ILocator object created from the location.
See Also:
ILocatorFactory.createLocator(java.lang.String)

getSearchPathDefinition

public java.lang.String getSearchPathDefinition()

getSearchPaths

public java.util.List getSearchPaths()

isSynchSynchronous

public boolean isSynchSynchronous()

setSearchPathDefinition

public void setSearchPathDefinition(java.lang.String searchPath)

setSearchPaths

public void setSearchPaths(java.util.List searchPaths)

setSynchSynchronous

public void setSynchSynchronous(boolean synchSynchronous)