com.helger.commons.io.file

Class SimpleFileIO

java.lang.Object

com.helger.commons.io.file.SimpleFileIO

@Immutable
public final class SimpleFileIO
extends Object

All kind of file handling stuff. For other operations, please see FileOperations class or the instance based FileOperationManager class.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
static byte[]	getAllFileBytes(File aFile) Get the content of the file as a byte array.
static ICommonsList<String>	getAllFileLines(File aFile, Charset aCharset) Get the content of the passed file as a list of lines, whereas each line does not contain a separator.
static String	getFileAsString(File aFile, Charset aCharset) Get the content of the passed file as a string using the system line separator.
static void	readFileLines(File aFile, Charset aCharset, Consumer<String> aConsumer) Get the content of the passed file as a list of lines, whereas each line does not contain a separator.
static void	readFileLines(File aFile, Charset aCharset, List<String> aTargetList) Get the content of the passed file as a list of lines, whereas each line does not contain a separator.
static ESuccess	writeFile(File aFile, byte[] aContent)
static ESuccess	writeFile(File aFile, byte[] aContent, int nOffset, int nLength)
static ESuccess	writeFile(File aFile, String sContent, Charset aCharset)

Methods inherited from class java.lang.Object

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

Method Detail

getAllFileBytes

@Nullable
public static byte[] getAllFileBytes(@Nullable
                                                File aFile)

Get the content of the file as a byte array.

Parameters:

aFile - The file to read. May be null.

Returns:

null if the passed file is null or if the passed file does not exist.

getFileAsString

@Nullable
public static String getFileAsString(@Nullable
                                                File aFile,
                                                @Nonnull
                                                Charset aCharset)

Get the content of the passed file as a string using the system line separator. Note: the last line does not end with the passed line separator.

Parameters:

aFile - The file to read. May be null.

aCharset - The character set to use. May not be null.

Returns:

null if the file does not exist, the content otherwise.

getAllFileLines

@Nullable
public static ICommonsList<String> getAllFileLines(@Nullable
                                                              File aFile,
                                                              @Nonnull
                                                              Charset aCharset)

Get the content of the passed file as a list of lines, whereas each line does not contain a separator.

Parameters:

aFile - The file to read. May be null.

aCharset - The character set to use. May not be null.

Returns:

null if the file does not exist, the content otherwise.

readFileLines

public static void readFileLines(@Nullable
                                 File aFile,
                                 @Nonnull
                                 Charset aCharset,
                                 @Nonnull
                                 List<String> aTargetList)

Get the content of the passed file as a list of lines, whereas each line does not contain a separator.

Parameters:

aFile - The file to read. May be null.

aCharset - The character set to use. May not be null.

aTargetList - The target list to be filled. May not be null.

readFileLines

public static void readFileLines(@Nullable
                                 File aFile,
                                 @Nonnull
                                 Charset aCharset,
                                 @Nonnull
                                 Consumer<String> aConsumer)

Get the content of the passed file as a list of lines, whereas each line does not contain a separator.

Parameters:

aFile - The file to read. May be null.

aCharset - The character set to use. May not be null.

aConsumer - The consumer to be invoked for each line. May not be null.

writeFile

@Nonnull
public static ESuccess writeFile(@Nonnull
                                           File aFile,
                                           @Nonnull
                                           byte[] aContent)

writeFile

@Nonnull
public static ESuccess writeFile(@Nonnull
                                           File aFile,
                                           @Nonnull
                                           byte[] aContent,
                                           @Nonnegative
                                           int nOffset,
                                           @Nonnegative
                                           int nLength)

writeFile

@Nonnull
public static ESuccess writeFile(@Nonnull
                                           File aFile,
                                           @Nonnull
                                           String sContent,
                                           @Nonnull
                                           Charset aCharset)