Module de.cuioss.java.tools

Package de.cuioss.tools.io

Class FileSystemLoader

java.lang.Object

de.cuioss.tools.io.FileSystemLoader

All Implemented Interfaces:

FileLoader, FileReaderWriter, FileWriter, Serializable

public class FileSystemLoader
extends Object
implements FileReaderWriter

File-system based variant. Responsible for all non FileTypePrefix.CLASSPATH files.

Author:

Oliver Wolff

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FileSystemLoader(String pathName)
FileSystemLoader(Path path)	Variant that uses a path as the constructor argument

Method Summary

Modifier and Type	Method	Description
static String	checkPathName(String pathName)	Checks and modifies a given pathName
Path	getPath()
URL	getURL()
InputStream	inputStream()	This method should be within a try-with-resources statement as it is not closed by the implementation.
boolean	isFilesystemLoader()
OutputStream	outputStream()	Truncate and overwrite an existing file, or create the file if it doesn't initially exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.cuioss.tools.io.FileLoader

getFileName, isReadable

Methods inherited from interface de.cuioss.tools.io.FileWriter

getFileName, isWritable

Constructor Details

FileSystemLoader

public FileSystemLoader(String pathName)

Parameters:

pathName - must not be null nor empty, must not start with the prefix "classpath:" but may start with the prefix "file:" and contain at least one character despite the prefix. On all other cases a IllegalArgumentException will be thrown.

FileSystemLoader

public FileSystemLoader(Path path)

Variant that uses a path as the constructor argument

Parameters:

path - must not be null

Method Details

getPath

public Path getPath()

Returns:

the path

inputStream

public InputStream inputStream()
                        throws IOException

Description copied from interface: FileLoader

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

Specified by:

inputStream in interface FileLoader

Returns:

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

Throws:

IOException

checkPathName

public static String checkPathName(String pathName)

Checks and modifies a given pathName

Parameters:

pathName - must not be null nor empty, must not start with the prefix "classpath:" but may start with the prefix "file:" and contain at least one character despite the prefix. On all other cases a IllegalArgumentException will be thrown.

Returns:

the normalized pathname without prefix

isFilesystemLoader

public boolean isFilesystemLoader()

Specified by:

isFilesystemLoader in interface FileLoader

Returns:

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

getURL

public URL getURL()

Specified by:

getURL in interface FileLoader

Returns:

an URL on the corresponding file.

outputStream

public OutputStream outputStream()
                          throws IOException

Truncate and overwrite an existing file, or create the file if it doesn't initially exist.

Specified by:

outputStream in interface FileWriter

Returns:

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

Throws:

IOException