Module de.cuioss.java.tools

Package de.cuioss.tools.io

Class FileLoaderUtility

java.lang.Object

de.cuioss.tools.io.FileLoaderUtility

public final class FileLoaderUtility
extends Object

Utility class for dealing with generic / classpath related file access.

Author:

Oliver Wolff

Constructor Summary

Constructors

Constructor	Description
FileLoaderUtility()

Method Summary

Modifier and Type	Method	Description
static Path	copyFileToTemp(FileLoader source, boolean markDeleteOnExit)	Helper class that copies the content of a FileLoader to the temp-folder and references it
static FileLoader	getLoaderForPath(String pathName)	Returns an implementation of FileLoader matching to the given path.
static String	toString(FileLoader fileLoader)	Convenience method for reading the content from a given FileLoader into a String read as UTF-8 String
static String	toString(FileLoader fileLoader, Charset charset)	Convenience method for reading the content from a given FileLoader into a String
static String	toStringUnchecked(FileLoader fileLoader)	Convenience method for reading the content from a given FileLoader into a String read as UTF-8 String

Methods inherited from class java.lang.Object

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

Constructor Details

FileLoaderUtility

public FileLoaderUtility()

Method Details

getLoaderForPath

public static FileLoader getLoaderForPath(String pathName)

Returns an implementation of FileLoader matching to the given path.

Parameters:

pathName - must not be null or empty.

Returns:

a configured implementation of FileLoader. In case the pathName is prefixed with FileTypePrefix.CLASSPATH it returns a ClassPathLoader. If prefixed with FileTypePrefix.URL it returns a UrlLoader. Otherwise, it returns a FileSystemLoader.

copyFileToTemp

public static Path copyFileToTemp(FileLoader source,
 boolean markDeleteOnExit)
                           throws IOException

Helper class that copies the content of a FileLoader to the temp-folder and references it

Caution: Security-Impact

Creating a temp-file might introduce a security issue. Never ever use this location for sensitive information that might be of interest for an attacker

Parameters:

source - must not be null and represent an accessible file, saying FileLoader.isReadable()

markDeleteOnExit - if true the file will be marked to delete on Exit.

Returns:

a reference on a file copied in the temp folder

Throws:

IOException

toString

public static String toString(FileLoader fileLoader,
 Charset charset)
                       throws IOException

Convenience method for reading the content from a given FileLoader into a String

Parameters:

fileLoader - must not be null

charset - must not be null

Returns:

The String content of the File represented by the given FileLoader

Throws:

IOException

toString

public static String toString(FileLoader fileLoader)
                       throws IOException

Convenience method for reading the content from a given FileLoader into a String read as UTF-8 String

Parameters:

fileLoader - must not be null

Returns:

The String content of the File represented by the given FileLoader

Throws:

IOException

toStringUnchecked

public static String toStringUnchecked(FileLoader fileLoader)

Convenience method for reading the content from a given FileLoader into a String read as UTF-8 String

Parameters:

fileLoader - must not be null

Returns:

The String content of the File represented by the given FileLoader

Throws:

IllegalArgumentException - masking the actual IOException

NullPointerException - if fileLoader is null