dk.heick.properties.types.utils

Class FileUtils

java.lang.Object

dk.heick.properties.types.utils.FileUtils

public class FileUtils
extends Object

Different utilities for files.

Since:

1.9

Author:

Frederik Heick

Constructor Summary

Constructors

Constructor and Description
FileUtils()

Method Summary

Modifier and Type	Method and Description
static byte[]	loadAsBytes(String propertyName, File file) Loading an array of bytes from a file.
static StringList	loadAsLines(String propertyName, File file) Load a file to a list of Strings, using the Files.readAllLines(File,Charset) and the Charset.defaultCharset().
static String	loadAsString(String propertyName, File file) Loads a file into a string using the InputStreamReader with a UTF_8 Charset and a default buffersize of 2048.
static String	loadAsString(String propertyName, File file, int bufferSize, String charsetName) Loads a file into a string using the InputStreamReader with a charset and buffersize.
static String	loadAsString(String propertyName, File file, String charsetName) Loads a file into a string using the InputStreamReader with a charset and a default buffersize of 2048.
static void	setFileLastModified(File file, long time) Calls File.setLastModified(long time).
static void	touch(File file) Sets the a file last modified timestamp to now.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUtils

public FileUtils()

Method Detail

loadAsString

public static final String loadAsString(String propertyName,
                                        File file)
                                 throws PropertyException

Loads a file into a string using the InputStreamReader with a UTF_8 Charset and a default buffersize of 2048.

Parameters:

propertyName - the name of the property from where the loadAsString has originated.

file - the file to read

Returns:

the File as String, with the valid encoding.

Throws:

PropertyException - if File is not found or unreadable, or the charsetName is invalid.

See Also:

loadAsString(String, File, int, String)

loadAsString

public static final String loadAsString(String propertyName,
                                        File file,
                                        String charsetName)
                                 throws PropertyException

Loads a file into a string using the InputStreamReader with a charset and a default buffersize of 2048.

Parameters:

propertyName - the name of the property from where the loadAsString has originated.

file - the file to read

charsetName - a valid charsetName for the encoding.

Returns:

the File as String, with the valid encoding.

Throws:

PropertyException - if File is not found or unreadable, or the charsetName is invalid.

See Also:

loadAsString(String, File, int, String)

loadAsString

public static final String loadAsString(String propertyName,
                                        File file,
                                        int bufferSize,
                                        String charsetName)
                                 throws PropertyException

Loads a file into a string using the InputStreamReader with a charset and buffersize.

Parameters:

propertyName - the name of the property from where the loadAsString has originated.

file - the file to read.

bufferSize - the buffer size to load the file with using the InputStreamReader.read(byte[],int,int) method, if bufferSize is less than 1, 2048 is used.

charsetName - a valid charsetName for the encoding.

Returns:

the File as String, with the valid encoding.

Throws:

PropertyException - if File is not found or unreadable, or the charsetName is invalid.

loadAsBytes

public static final byte[] loadAsBytes(String propertyName,
                                       File file)
                                throws PropertyException

Loading an array of bytes from a file.

Parameters:

propertyName - the name of property, using this method.

file - the file to load the bytes from

Returns:

an array of bytes.

Throws:

PropertyException - if file not found or unreadable.

Since:

1.9

loadAsLines

public static final StringList loadAsLines(String propertyName,
                                           File file)
                                    throws PropertyException

Load a file to a list of Strings, using the Files.readAllLines(File,Charset) and the Charset.defaultCharset().

Parameters:

propertyName - the name of property, using this method.

file - the file

Returns:

the list of strings in the file.

Throws:

PropertyException - if the file could not be loaded.

touch

public static void touch(File file)
                  throws IOException

Sets the a file last modified timestamp to now.

Parameters:

file - the file to touch.

Throws:

IOException - if the file is null, or any SecurityException is thrown.

See Also:

File.setLastModified(long), setFileLastModified(File, long)

setFileLastModified

public static void setFileLastModified(File file,
                                       long time)
                                throws IOException

Calls File.setLastModified(long time).

Parameters:

file - the file whose modified time is to be set, if less than zero, current time milliseconds is used.

time - the time to which the last modified time is to be set. If this is -1, the current time is used.

Throws:

IOException

See Also:

File.setLastModified(long)