Package org.greenrobot.essentials.io

Class FileUtils

java.lang.Object

org.greenrobot.essentials.io.FileUtils

public class FileUtils
extends Object

Utils for dealing with files.

Constructor Summary

Constructors

Constructor	Description
FileUtils()

Method Summary

Modifier and Type	Method	Description
static void	appendUtf8(File file, CharSequence text)
static void	copyFile(File from, File to)	Copies a file to another location.
static void	copyFile(String fromFilename, String toFilename)	Copies a file to another location.
static void	deleteDirRecursive(File dir)	Deletes all files within the given directory recursively (including subdirectories).
static boolean	deleteDirRecursiveBestEffort(File dir)	Deletes all files within the given directory recursively (including subdirectories).
private static File	deleteDirRecursiveInternal(File dir, boolean failFast)
static String	getMd5(File file)
static String	getSha1(File file)
static String	getSha256(File file)
static byte[]	readBytes(File file)
static String	readChars(File file, String charset)
static <T> T	readObject(File file)	To read an object in a quick invalid input: '&' dirty way.
static String	readUtf8(File file)
static void	updateChecksum(File file, Checksum checksum)
static void	writeBytes(File file, byte[] content)
static void	writeChars(File file, String charset, CharSequence text, boolean apppend)
static void	writeObject(File file, Object object)	To store an object in a quick invalid input: '&' dirty way.
static void	writeUtf8(File file, CharSequence text)

Methods inherited from class java.lang.Object

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

Constructor Details

FileUtils

public FileUtils()

Method Details

readBytes

public static byte[] readBytes(File file)
                        throws IOException

Throws:

IOException

writeBytes

public static void writeBytes(File file,
 byte[] content)
                       throws IOException

Throws:

IOException

readUtf8

public static String readUtf8(File file)
                       throws IOException

Throws:

IOException

readChars

public static String readChars(File file,
 String charset)
                        throws IOException

Throws:

IOException

writeUtf8

public static void writeUtf8(File file,
 CharSequence text)
                      throws IOException

Throws:

IOException

appendUtf8

public static void appendUtf8(File file,
 CharSequence text)
                       throws IOException

Throws:

IOException

writeChars

public static void writeChars(File file,
 String charset,
 CharSequence text,
 boolean apppend)
                       throws IOException

Throws:

IOException

copyFile

public static void copyFile(File from,
 File to)
                     throws IOException

Copies a file to another location.

Throws:

IOException

copyFile

public static void copyFile(String fromFilename,
 String toFilename)
                     throws IOException

Copies a file to another location.

Throws:

IOException

readObject

public static <T> T readObject(File file)
                        throws IOException,
ClassNotFoundException

To read an object in a quick invalid input: '&' dirty way. Prepare to handle failures when object serialization changes!

Throws:

IOException

ClassNotFoundException

writeObject

public static void writeObject(File file,
 Object object)
                        throws IOException

To store an object in a quick invalid input: '&' dirty way.

Throws:

IOException

getMd5

public static String getMd5(File file)
                     throws IOException

Returns:

MD5 digest (32 hex characters).

Throws:

IOException

getSha1

public static String getSha1(File file)
                      throws IOException

Returns:

SHA-1 digest (40 hex characters).

Throws:

IOException

getSha256

public static String getSha256(File file)
                        throws IOException

Returns:

SHA-256 digest (64 hex characters).

Throws:

IOException

updateChecksum

public static void updateChecksum(File file,
 Checksum checksum)
                           throws IOException

Throws:

IOException

deleteDirRecursive

public static void deleteDirRecursive(File dir)
                               throws IOException

Deletes all files within the given directory recursively (including subdirectories). This method fails fast with an IOException on the first file that could not be deleted.

Throws:

IOException

deleteDirRecursiveBestEffort

public static boolean deleteDirRecursiveBestEffort(File dir)

Deletes all files within the given directory recursively (including subdirectories). It will try to delete as many files as possible (best effort) and will not fail on files that couldn't be deleted.

Returns:

true if the given dir does not exist anymore on completion of this method

deleteDirRecursiveInternal

private static File deleteDirRecursiveInternal(File dir,
 boolean failFast)

Returns:

File that could not be deleted (fail fast mode only)