Package io.cui.tools.io

Class ClassPathLoader

java.lang.Object

io.cui.tools.io.ClassPathLoader

All Implemented Interfaces:

FileLoader, Serializable

public class ClassPathLoader
extends Object
implements FileLoader

Variant of FileLoader that loads files from the classpath.

Author:

Oliver Wolff

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ClassPathLoader(String pathName)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
StructuredFilename	getFileName()
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()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassPathLoader

public ClassPathLoader(String pathName)

Parameters:

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

Method Detail

isReadable

public boolean isReadable()

Specified by:

isReadable in interface FileLoader

Returns:

boolean indicating whether the concrete file exists and is accessible

inputStream

public InputStream inputStream()

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.

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.

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

getFileName

public StructuredFilename getFileName()

Specified by:

getFileName in interface FileLoader

Returns:

the filename in an appropriate presentation.