Package io.cui.tools.io

Class UrlLoader

java.lang.Object

io.cui.tools.io.UrlLoader

All Implemented Interfaces:

FileLoader, Serializable

public class UrlLoader
extends Object
implements FileLoader

This FileLoader takes a URL as its parameter which is useful when e.g. iterating over an enumeration of URLs from ClassLoader.getResources(String). It converts the given URL to a String and prefixes it with FileTypePrefix.URL.

Author:

Sven Haag

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
UrlLoader(String url)
UrlLoader(URL url)

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

UrlLoader

public UrlLoader(String url)

Parameters:

url - representing a valid URL

Throws:

IllegalArgumentException - indicating that the given String represents a valid URL

UrlLoader

public UrlLoader(URL url)

Parameters:

url - hopefully a JAR URL

Method Detail

isReadable

public boolean isReadable()

Specified by:

isReadable in interface FileLoader

Returns:

true, if a connection to getURL() can be established

getFileName

public StructuredFilename getFileName()

Specified by:

getFileName in interface FileLoader

Returns:

the filename in an appropriate presentation.

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

getURL

public URL getURL()

Specified by:

getURL in interface FileLoader

Returns:

an URL on the corresponding file.

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

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