manifold.io.extensions.java.io.File

Class ManFileReadWriteExt

java.lang.Object

manifold.io.extensions.java.io.File.ManFileReadWriteExt

public class ManFileReadWriteExt
extends java.lang.Object

Adapted from kotlin.io.FileReadWrite

Constructor Summary

Constructors

Constructor and Description
ManFileReadWriteExt()

Method Summary

Modifier and Type	Method and Description
static void	appendBytes(java.io.File thiz, byte[] array) Appends an [array] of bytes to the content of this file.
static void	appendText(java.io.File thiz, java.lang.String text) Appends [text] to the content of this file using UTF-8 or the specified [charset].
static void	appendText(java.io.File thiz, java.lang.String text, java.nio.charset.Charset charset)
static java.io.BufferedReader	bufferedReader(java.io.File thiz) Returns a new [BufferedReader] for reading the content of this file.
static java.io.BufferedReader	bufferedReader(java.io.File thiz, java.nio.charset.Charset charset, int bufferSize)
static java.io.BufferedWriter	bufferedWriter(java.io.File thiz) Returns a new [BufferedWriter] for writing the content of this file.
static java.io.BufferedWriter	bufferedWriter(java.io.File thiz, java.nio.charset.Charset charset, int bufferSize)
static void	forEachBlock(java.io.File thiz, java.util.function.BiConsumer<byte[],java.lang.Integer> action) Reads file by byte blocks and calls [action] for each block read.
static void	forEachBlock(java.io.File thiz, int blockSize, java.util.function.BiConsumer<byte[],java.lang.Integer> action) Reads file by byte blocks and calls [action] for each block read.
static void	forEachLine(java.io.File thiz, java.nio.charset.Charset charset, java.util.function.Consumer<java.lang.String> action) Reads this file line by line using the specified [charset] and calls [action] for each line.
static java.io.FileInputStream	inputStream(java.io.File thiz) Constructs a new FileInputStream of this file and returns it as a result.
static java.io.FileOutputStream	outputStream(java.io.File thiz) Constructs a new FileOutputStream of this file and returns it as a result.
static java.io.PrintWriter	printWriter(java.io.File thiz) Returns a new [PrintWriter] for writing the content of this file.
static java.io.PrintWriter	printWriter(java.io.File thiz, java.nio.charset.Charset charset)
static byte[]	readBytes(java.io.File thiz) Gets the entire content of this file as a byte array.
static java.io.InputStreamReader	reader(java.io.File thiz) Returns a new [FileReader] for reading the content of this file.
static java.io.InputStreamReader	reader(java.io.File thiz, java.nio.charset.Charset charset)
static java.util.List<java.lang.String>	readLines(java.io.File thiz, java.nio.charset.Charset charset) Reads the file content as a list of lines.
static java.lang.String	readText(java.io.File thiz) Gets the entire content of this file as a String using UTF-8 or specified [charset].
static java.lang.String	readText(java.io.File thiz, java.nio.charset.Charset charset)
static <T> T	useLines(java.io.File thiz, java.nio.charset.Charset charset, java.util.function.Function<java.lang.Iterable<java.lang.String>,T> block) Calls the [block] callback giving it a sequence of all the lines in this file and closes the reader once the processing is complete.
static void	writeBytes(java.io.File thiz, byte[] array) Sets the content of this file as an [array] of bytes.
static java.io.OutputStreamWriter	writer(java.io.File thiz) Returns a new [FileWriter] for writing the content of this file.
static java.io.OutputStreamWriter	writer(java.io.File thiz, java.nio.charset.Charset charset)
static void	writeText(java.io.File thiz, java.lang.String text) Sets the content of this file as [text] encoded using UTF-8 or specified [charset].
static void	writeText(java.io.File thiz, java.lang.String text, java.nio.charset.Charset charset)

Methods inherited from class java.lang.Object

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

Constructor Detail

ManFileReadWriteExt

public ManFileReadWriteExt()

Method Detail

reader

public static java.io.InputStreamReader reader(java.io.File thiz)

Returns a new [FileReader] for reading the content of this file.

reader

public static java.io.InputStreamReader reader(java.io.File thiz,
                                               java.nio.charset.Charset charset)

bufferedReader

public static java.io.BufferedReader bufferedReader(java.io.File thiz)

Returns a new [BufferedReader] for reading the content of this file.

Parameters:

bufferSize - necessary size of the buffer.

bufferedReader

public static java.io.BufferedReader bufferedReader(java.io.File thiz,
                                                    java.nio.charset.Charset charset,
                                                    int bufferSize)

writer

public static java.io.OutputStreamWriter writer(java.io.File thiz)

Returns a new [FileWriter] for writing the content of this file.

writer

public static java.io.OutputStreamWriter writer(java.io.File thiz,
                                                java.nio.charset.Charset charset)

bufferedWriter

public static java.io.BufferedWriter bufferedWriter(java.io.File thiz)

Returns a new [BufferedWriter] for writing the content of this file.

Parameters:

bufferSize - necessary size of the buffer.

bufferedWriter

public static java.io.BufferedWriter bufferedWriter(java.io.File thiz,
                                                    java.nio.charset.Charset charset,
                                                    int bufferSize)

printWriter

public static java.io.PrintWriter printWriter(java.io.File thiz)

Returns a new [PrintWriter] for writing the content of this file.

printWriter

public static java.io.PrintWriter printWriter(java.io.File thiz,
                                              java.nio.charset.Charset charset)

readBytes

public static byte[] readBytes(java.io.File thiz)

Gets the entire content of this file as a byte array.

This method is not recommended on huge files. It has an internal limitation of 2 GB byte array size.

Returns:

the entire content of this file as a byte array.

writeBytes

public static void writeBytes(java.io.File thiz,
                              byte[] array)

Sets the content of this file as an [array] of bytes. If this file already exists, it becomes overwritten.

Parameters:

array - byte array to write into this file.

appendBytes

public static void appendBytes(java.io.File thiz,
                               byte[] array)

Appends an [array] of bytes to the content of this file.

Parameters:

array - byte array to append to this file.

readText

public static java.lang.String readText(java.io.File thiz)

Gets the entire content of this file as a String using UTF-8 or specified [charset].

This method is not recommended on huge files. It has an internal limitation of 2 GB file size.

Parameters:

charset - character set to use.

Returns:

the entire content of this file as a String.

readText

public static java.lang.String readText(java.io.File thiz,
                                        java.nio.charset.Charset charset)

writeText

public static void writeText(java.io.File thiz,
                             java.lang.String text)

Sets the content of this file as [text] encoded using UTF-8 or specified [charset]. If this file exists, it becomes overwritten.

Parameters:

text - text to write into file.

charset - character set to use.

writeText

public static void writeText(java.io.File thiz,
                             java.lang.String text,
                             java.nio.charset.Charset charset)

appendText

public static void appendText(java.io.File thiz,
                              java.lang.String text)

Appends [text] to the content of this file using UTF-8 or the specified [charset].

Parameters:

text - text to append to file.

charset - character set to use.

appendText

public static void appendText(java.io.File thiz,
                              java.lang.String text,
                              java.nio.charset.Charset charset)

forEachBlock

public static void forEachBlock(java.io.File thiz,
                                java.util.function.BiConsumer<byte[],java.lang.Integer> action)

Reads file by byte blocks and calls [action] for each block read. Block has default size which is implementation-dependent. This functions passes the byte array and amount of bytes in the array to the [action] function.

You can use this function for huge files.

Parameters:

action - function to process file blocks.

forEachBlock

public static void forEachBlock(java.io.File thiz,
                                int blockSize,
                                java.util.function.BiConsumer<byte[],java.lang.Integer> action)

Reads file by byte blocks and calls [action] for each block read. This functions passes the byte array and amount of bytes in the array to the [action] function.

You can use this function for huge files.

Parameters:

action - function to process file blocks.

blockSize - size of a block, replaced by 512 if it's less, 4096 by default.

forEachLine

public static void forEachLine(java.io.File thiz,
                               java.nio.charset.Charset charset,
                               java.util.function.Consumer<java.lang.String> action)

Reads this file line by line using the specified [charset] and calls [action] for each line. Default charset is UTF-8.

You may use this function on huge files.

Parameters:

charset - character set to use.

action - function to process file lines.

inputStream

public static java.io.FileInputStream inputStream(java.io.File thiz)

Constructs a new FileInputStream of this file and returns it as a result.

outputStream

public static java.io.FileOutputStream outputStream(java.io.File thiz)

Constructs a new FileOutputStream of this file and returns it as a result.

readLines

public static java.util.List<java.lang.String> readLines(java.io.File thiz,
                                                         java.nio.charset.Charset charset)

Reads the file content as a list of lines.

Do not use this function for huge files.

Parameters:

charset - character set to use. By default uses UTF-8 charset.

Returns:

list of file lines.

useLines

public static <T> T useLines(java.io.File thiz,
                             java.nio.charset.Charset charset,
                             java.util.function.Function<java.lang.Iterable<java.lang.String>,T> block)

Calls the [block] callback giving it a sequence of all the lines in this file and closes the reader once the processing is complete.

Parameters:

charset - character set to use. By default uses UTF-8 charset.

Returns:

the value returned by [block].