com.phloc.commons.io.file

Class SimpleFileIO

java.lang.Object

com.phloc.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

Methods

Modifier and Type	Method and Description
static String	readFileAsString(File aFile, Charset aCharset) Get the content of the passed file as a string using the system line separator.
static String	readFileAsString(File aFile, String sCharset) Deprecated.
static byte[]	readFileBytes(File aFile) Get the content of the file as a byte array.
static List<String>	readFileLines(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 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 List<String>	readFileLines(File aFile, String sCharset) Deprecated.
static void	readFileLines(File aFile, String sCharset, List<String> aTargetList) Deprecated.
static ESuccess	writeFile(File aFile, byte[] aContent)
static ESuccess	writeFile(File aFile, byte[] aContent, int nOffset, int nLength)
static ESuccess	writeFile(File aFile, List<String> aContent, Charset aCharset)
static ESuccess	writeFile(File aFile, List<String> aContent, String sCharset) Deprecated.
static ESuccess	writeFile(File aFile, String sContent, Charset aCharset)
static ESuccess	writeFile(File aFile, String sContent, String sCharset) Deprecated.

Methods inherited from class java.lang.Object

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

Method Detail

readFileBytes

@Nullable
public static byte[] readFileBytes(@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.

readFileAsString

@Nullable
@Deprecated
public static String readFileAsString(@Nullable
                                          File aFile,
                                          @Nonnull
                                          String sCharset)

Deprecated.

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.

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

Returns:

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

readFileAsString

@Nullable
public static String readFileAsString(@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.

readFileLines

@Nullable
@Deprecated
public static List<String> readFileLines(@Nullable
                                             File aFile,
                                             @Nonnull
                                             String sCharset)

Deprecated.

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.

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

Returns:

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

readFileLines

@Nullable
public static List<String> readFileLines(@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

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

Deprecated.

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.

sCharset - 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
                 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.

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
@Deprecated
public static ESuccess writeFile(@Nonnull
                                    File aFile,
                                    @Nonnull
                                    String sContent,
                                    @Nonnull
                                    String sCharset)

Deprecated.

writeFile

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

writeFile

@Nonnull
@Deprecated
public static ESuccess writeFile(@Nonnull
                                    File aFile,
                                    @Nonnull
                                    List<String> aContent,
                                    @Nonnull
                                    String sCharset)

Deprecated.

writeFile

@Nonnull
public static ESuccess writeFile(@Nonnull
                         File aFile,
                         @Nonnull
                         List<String> aContent,
                         @Nonnull
                         Charset aCharset)