de.intarsys.tools.locator

Interface ILocatorFactory

All Known Implementing Classes:

ClassLoaderResourceLocatorFactory, CommonLocatorFactory, DelegatingLocatorFactory, ExpandingLocatorFactory, FileLocatorFactory, LookupLocatorFactory, MappedLocatorLookup, RelativeLocatorFactory, SchemeBasedLocatorFactory, SearchPathLocatorFactory, TrustedLocatorFactory, ZipFileLocatorFactory

public interface ILocatorFactory

A factory for an ILocator.

Method Summary

Methods

Modifier and Type	Method and Description
ILocator	createLocator(String location) Create an ILocator.

Method Detail

createLocator

ILocator createLocator(String location)
                       throws IOException

Create an ILocator. If location is null or an empty string, null is returned. location may for example define a file in the file system and the factory returns the corresponding FileLocator. The factory may return an ILocator to a resource that does not (yet) exist, but is a valid ILocator. The factory itself does not perform any check for physical existence on a syntactically valid ILocator. If there's no way that a location can be resolved to a valid ILocator, the ILocatorFactory throws an IOException. If the failure is related to non-existence, the factory should throw a FileNotFoundException.

Parameters:

location - A location definition.

Returns:

The ILocator object created from location.

Throws:

IOException