Module de.cuioss.java.tools

Package de.cuioss.tools.io

Interface FileLoader

All Superinterfaces:

Serializable

All Known Subinterfaces:

FileReaderWriter

All Known Implementing Classes:

ClassPathLoader, FileSystemLoader, UrlLoader

public interface FileLoader
extends Serializable

Wraps different ways file loading: FileSystem (absolute), Classpath,..

The implementations must be reentrant regarding inputStream()

Author:

Oliver Wolff

Method Summary

Modifier and Type	Method	Description
StructuredFilename	getFileName()
URL	getURL()
InputStream	inputStream()	This method should be within a try-with-resources statement as it is not closed by the implementation.
boolean	isFilesystemLoader()
boolean	isReadable()

Method Details

isReadable

boolean isReadable()

Returns:

boolean indicating whether the concrete file exists and is accessible

getFileName

StructuredFilename getFileName()

Returns:

the filename in an appropriate presentation.

inputStream

InputStream inputStream()
                 throws IOException

This method should be within a try-with-resources statement as it is not closed by the implementation.

Returns:

an InputStream on the corresponding file. It implicitly checks isReadable() before accessing the file and will throw an IllegalStateException in case it is not readable.

Throws:

IOException

getURL

URL getURL()

Returns:

an URL on the corresponding file.

isFilesystemLoader

boolean isFilesystemLoader()

Returns:

boolean indicating that the loader loads from the file-system and not from the classpath