Package io.cui.tools.io

Class FileSystemLoader

java.lang.Object

io.cui.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
protected boolean	canEqual(Object other)
static String	checkPathName(String pathName)	Checks and modifies a given pathName
boolean	equals(Object o)
StructuredFilename	getFileName()
Path	getPath()
URL	getURL()
int	hashCode()
InputStream	inputStream()	This method should be within a try-with-resources statement as it is not closed by the implementation.
boolean	isFilesystemLoader()
boolean	isReadable()
boolean	isWritable()
OutputStream	outputStream()	Truncate and overwrite an existing file, or create the file if it doesn't initially exist.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

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 Detail

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

isReadable

public boolean isReadable()

Specified by:

isReadable in interface FileLoader

Returns:

boolean indicating whether the concrete file exists and is accessible

isWritable

public boolean isWritable()

Specified by:

isWritable in interface FileWriter

Returns:

true if an actual file is writable.

getFileName

public StructuredFilename getFileName()

Specified by:

getFileName in interface FileLoader

Specified by:

getFileName in interface FileWriter

Returns:

the filename in an appropriate presentation.