Interface FileLookup

All Known Implementing Classes:

AbstractFileLookup, FileLookupFactory.DefaultFileLookup

public interface FileLookup

Method Summary

Modifier and Type	Method	Description
InputStream	lookupFile(String filename, ClassLoader cl)	Looks up the file, see : FileLookupFactory.DefaultFileLookup.
URL	lookupFileLocation(String filename, ClassLoader cl)	Looks up the file and returns its URL
Collection<URL>	lookupFileLocations(String filename, ClassLoader cl)
URL	lookupFileLocationStrict(String filename, ClassLoader cl)	Same as lookupFileLocation(String, ClassLoader) but throws a FileNotFoundException if the file cannot be found.
InputStream	lookupFileStrict(String filename, ClassLoader cl)	Looks up the file, see : FileLookupFactory.DefaultFileLookup.
InputStream	lookupFileStrict(URI uri, ClassLoader cl)	Looks up the file, see : FileLookupFactory.DefaultFileLookup.

Method Details

lookupFile

InputStream lookupFile(String filename,
 ClassLoader cl)

Looks up the file, see : FileLookupFactory.DefaultFileLookup.

Parameters:

filename - might be the name of the file (too look it up in the class path) or an url to a file.

Returns:

an input stream to the file or null if nothing found through all lookup steps.

lookupFileStrict

InputStream lookupFileStrict(String filename,
 ClassLoader cl)
                      throws FileNotFoundException

Looks up the file, see : FileLookupFactory.DefaultFileLookup.

Parameters:

filename - might be the name of the file (to look it up in the class path) or an url to a file.

Returns:

an input stream to the file or null if nothing found through all lookup steps.

Throws:

FileNotFoundException - if file cannot be found

lookupFileStrict

InputStream lookupFileStrict(URI uri,
 ClassLoader cl)
                      throws FileNotFoundException

Looks up the file, see : FileLookupFactory.DefaultFileLookup.

Parameters:

uri - An absolute, hierarchical URI with a scheme equal to "file" that represents the file to lookup

Returns:

an input stream to the file or null if nothing found through all lookup steps.

Throws:

FileNotFoundException - if file cannot be found

lookupFileLocation

URL lookupFileLocation(String filename,
 ClassLoader cl)

Looks up the file and returns its URL

Parameters:

filename -

cl -

Returns:

the URL pointing to the file, null if it cannot be found

lookupFileLocationStrict

URL lookupFileLocationStrict(String filename,
 ClassLoader cl)
                      throws FileNotFoundException

Same as lookupFileLocation(String, ClassLoader) but throws a FileNotFoundException if the file cannot be found.

Parameters:

filename -

cl -

Returns:

Throws:

FileNotFoundException

lookupFileLocations

Collection<URL> lookupFileLocations(String filename,
 ClassLoader cl)
                             throws IOException

Throws:

IOException