org.danilopianini.io

Class FileUtilities

java.lang.Object

org.danilopianini.io.FileUtilities

public final class FileUtilities
extends Object

This is a collection of tools for manipulating the file system.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	BACKUP_EXTENSION

Constructor Summary

Constructors

Modifier	Constructor and Description
private	FileUtilities()

Method Summary

Modifier and Type	Method and Description
static <T extends Serializable> T	cloneObject(T x) This method provides a shortcut to deep clone Serializable objects.
static <T extends Serializable> T	deserializeObject(byte[] b) Serializes an object in memory.
static long	fileCRC32sum(File f) Computes the CRC32 sum for a given file.
static Serializable	fileToObject(File f) This method tries to resemble an Object from a file.
static Object	fileToObject(String path) This method tries to resemble an Object from a file.
static String	fileToString(File f) Deprecated. Developers should use FileUtils.readFileToString(File, String) from Apache Commons IO
static String	fileToString(String path) Deprecated. Use fileUTF8ToString(String) instead, or specify a Charset.
static String	fileToString(String path, Charset c) This method tries to read a file and to instance it as a String.
static String	fileUTF8ToString(String path) This method tries to read a file and to instance it as a String.
static boolean	isInHiddenPath(File file) Tests whether or not any parent of the given file is hidden.
static Image	loadImage(String path) This method loads an Image from the file system.
static void	objectToFile(Object s, File f, boolean backup) This method serializes an Object into a File.
static void	objectToFile(Serializable s, String path, boolean backup) This method serializes an Object into a File.
static byte[]	serializeObject(Serializable x) Serializes an object in memory.
static void	stringToFile(String s, File f, boolean append) Deprecated. use FileUtils.writeStringToFile(File, String, Charset) instead
static void	stringToFile(String string, String path) Deprecated. use FileUtils.writeStringToFile(File, String, Charset) instead
static void	stringToFile(String string, String path, boolean append) Deprecated. use FileUtils.writeStringToFile(File, String, Charset, boolean) instead

Methods inherited from class java.lang.Object

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

Field Detail

BACKUP_EXTENSION

private static final String BACKUP_EXTENSION

See Also:

Constant Field Values

Constructor Detail

FileUtilities

private FileUtilities()

Method Detail

cloneObject

public static <T extends Serializable> T cloneObject(T x)
                                              throws IOException,
                                                     ClassNotFoundException

This method provides a shortcut to deep clone Serializable objects.

Type Parameters:

T - the Object type

Parameters:

x - the object to clone

Returns:

a deep clone of x

Throws:

IOException - If your memory fails

ClassNotFoundException - it never should

deserializeObject

public static <T extends Serializable> T deserializeObject(byte[] b)

Serializes an object in memory. Its representation as byte[] is returned

Type Parameters:

T - the Object type

Parameters:

b - the byte array representation of object to serialize

Returns:

The Object

fileCRC32sum

public static long fileCRC32sum(File f)
                         throws IOException

Computes the CRC32 sum for a given file.

Parameters:

f - the file

Returns:

the CRC32

Throws:

IOException - if an I/O error occurs

fileToObject

public static Serializable fileToObject(File f)
                                 throws IOException,
                                        ClassNotFoundException

This method tries to resemble an Object from a file.

Parameters:

f - the file to load

Returns:

the loaded Object (already cast to Serializable)

Throws:

IOException - in case of I/O errors

ClassNotFoundException - in case there is no compatible Class in Classpath for the Object to be loaded

fileToObject

public static Object fileToObject(String path)
                           throws IOException,
                                  ClassNotFoundException

This method tries to resemble an Object from a file.

Parameters:

path - the path of the file to load

Returns:

the loaded Object (already cast to Serializable)

Throws:

IOException - in case of I/O errors

ClassNotFoundException - in case there is no compatible Class in Classpath for the Object to be loaded

fileToString

@Deprecated
public static String fileToString(File f)
                                       throws IOException

Deprecated. Developers should use FileUtils.readFileToString(File, String) from Apache Commons IO

This method tries to read a file and to instance it as a String.

Parameters:

f - the file to read

Returns:

the file as String

Throws:

IOException - in case of I/O errors

fileToString

@Deprecated
public static String fileToString(String path)
                                       throws IOException

Deprecated. Use fileUTF8ToString(String) instead, or specify a Charset.

This method tries to read a file and to instance it as a String.

Parameters:

path - the path of the file to read

Returns:

the file as String

Throws:

IOException - in case of I/O errors

fileUTF8ToString

public static String fileUTF8ToString(String path)
                               throws IOException

This method tries to read a file and to instance it as a String.

Parameters:

path - the path of the file to read

Returns:

the file as String

Throws:

IOException - in case of I/O errors

fileToString

public static String fileToString(String path,
                                  Charset c)
                           throws IOException

This method tries to read a file and to instance it as a String.

Parameters:

path - the path of the file to read

c - the Charset to use

Returns:

the file as String

Throws:

IOException - in case of I/O errors

isInHiddenPath

public static boolean isInHiddenPath(File file)

Tests whether or not any parent of the given file is hidden.

Parameters:

file - the file to test

Returns:

true if at least one of the parent directories is hidden

loadImage

public static Image loadImage(String path)

This method loads an Image from the file system.

Parameters:

path - the path of the file to read

Returns:

the loaded image

objectToFile

public static void objectToFile(Object s,
                                File f,
                                boolean backup)
                         throws IOException

This method serializes an Object into a File.

Parameters:

s - the Object to serialize

f - the File which will contain the serialized Object

backup - If true and the file already exists, the ".bak" extension will be added to the existing file, preventing overwriting

Throws:

IOException - in case of I/O errors

objectToFile

public static void objectToFile(Serializable s,
                                String path,
                                boolean backup)
                         throws IOException

This method serializes an Object into a File.

Parameters:

s - the Object to serialize

path - the path of the File which will contain the serialized Object

backup - If true and the file already exists, the ".bak" extension will be added to the existing file, preventing overwriting

Throws:

IOException - in case of I/O errors

serializeObject

public static byte[] serializeObject(Serializable x)

Serializes an object in memory. Its representation as byte[] is returned

Parameters:

x - the object to serialize

Returns:

its byte array representation

stringToFile

@Deprecated
public static void stringToFile(String s,
                                            File f,
                                            boolean append)
                                     throws IOException

Deprecated. use FileUtils.writeStringToFile(File, String, Charset) instead

This method takes a String and save it as a Text file.

Parameters:

s - the String to save

f - the File to write to

append - decides whether to append or overwrite the file

Throws:

IOException - in case of I/O errors

stringToFile

public static void stringToFile(String string,
                                String path)
                         throws IOException

Deprecated. use FileUtils.writeStringToFile(File, String, Charset) instead

This method takes a String and save it as a Text file. This method overwrites.

Parameters:

string - the String to save

path - the path of the File to write to

Throws:

IOException - in case of I/O errors

stringToFile

public static void stringToFile(String string,
                                String path,
                                boolean append)
                         throws IOException

Deprecated. use FileUtils.writeStringToFile(File, String, Charset, boolean) instead

/** This method takes a String and save it as a Text file.

Parameters:

string - the String to save

path - the File to write to

append - decides whether to append or overwrite the file

Throws:

IOException - in case of I/O errors