Please note that this documentation is not final and is subject to change.

java.io
Class Outputs

java.lang.Object
  java.io.Outputs

public final class Outputs
extends Object

This class consists exclusively of static methods that operate on output destinations.

The methods to write lines of text output a line terminator following each line. The line terminator that is output is the platform line terminator, as defined by the line.separator system property.

Since:

1.7

Method Summary

Modifier and Type	Method and Description
static void	writeAllBytes(FileRef file, byte[] bytes) Write a byte array to a file.
static void	writeAllBytes(OutputStream out, InputStream in) Write all bytes to the given output stream from the given input stream.
static void	writeBytes(FileRef file, byte[] bytes, int off, int len) Writes a byte array to a file.
static void	writeLines(FileRef file, Iterable<String> lines) Writes the given lines of text to the specified file.
static void	writeLines(FileRef file, Iterable<String> lines, String csn) Writes the given lines of text to the specified file.
static void	writeLines(FileRef file, String... lines) Writes the given lines of text to the specified file.
static void	writeLines(OutputStream out, Iterable<String> lines) Writes the given lines of text to the specified output stream.
static void	writeLines(OutputStream out, Iterable<String> lines, String csn) Writes the given lines of text to the specified output stream.

Methods inherited from class java.lang.Object

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

Method Detail

writeAllBytes

public static void writeAllBytes(FileRef file,
                                 byte[] bytes)
                          throws IOException

Write a byte array to a file. The file is created if it does not exist. If the file already exists, it is replaced or first truncated.

Parameters:

file - the destination file

bytes - the array containing the bytes to write

Throws:

IOException - If an I/O error occurs

writeBytes

public static void writeBytes(FileRef file,
                              byte[] bytes,
                              int off,
                              int len)
                       throws IOException

Writes a byte array to a file. The file is created if it does not exist. If the file already exists, it is replaced or first truncated.

Parameters:

file - the destination file

bytes - the array containing the bytes to write

off - the start offset in the data

len - the number of bytes to write

Throws:

IndexOutOfBoundsException - If off or len is negative, or off+len is greater than the length of the array

IOException - If an I/O error occurs

writeAllBytes

public static void writeAllBytes(OutputStream out,
                                 InputStream in)
                          throws IOException

Write all bytes to the given output stream from the given input stream. On return, the input stream will be at end of stream.

Parameters:

out - the output stream to write to

in - the input stream to read from

Throws:

IOException - If an I/O error occurs when reading or writing

writeLines

public static void writeLines(FileRef file,
                              Iterable<String> lines,
                              String csn)
                       throws IOException

Writes the given lines of text to the specified file. The characters in each line are encoded into bytes using the specified Charset. When all lines have been written, or an I/O error occurs, then the file is closed.

Parameters:

file - The file

lines - The list of lines to write (in order)

csn - the name of the charset to be used

Throws:

IllegalArgumentException - if the charset name is illegal or not available in this instance of the Java virtual machine

UnmappableCharacterException - Where a line contains a character that cannot be mapped to an output byte sequence

IOException - If an I/O error occurs

writeLines

public static void writeLines(FileRef file,
                              Iterable<String> lines)
                       throws IOException

Writes the given lines of text to the specified file. The characters in each line are encoded into bytes using the underlying platform's default charset. When all lines have been written, or an I/O error occurs, then the file is closed.

Parameters:

file - The file

lines - The list of lines to write (in order)

Throws:

UnmappableCharacterException - Where a line contains a character that cannot be mapped to an output byte sequence

IOException - If an I/O error occurs

writeLines

public static void writeLines(FileRef file,
                              String... lines)
                       throws IOException

Writes the given lines of text to the specified file. The characters in each line are encoded into bytes using the underlying platform's default charset. When all lines have been written, or an I/O error occurs, then the file is closed.

Parameters:

file - The file

lines - The array of lines to write (in order)

Throws:

UnmappableCharacterException - Where a line contains a character that cannot be mapped to an output byte sequence

IOException - If an I/O error occurs

writeLines

public static void writeLines(OutputStream out,
                              Iterable<String> lines,
                              String csn)
                       throws IOException

Writes the given lines of text to the specified output stream. The characters in each line are encoded into bytes using the specified charset.

Parameters:

out - The output stream

lines - The list of lines to write (in order)

csn - the name of the charset to be used

Throws:

IllegalArgumentException - if the charset name is illegal or not available in this instance of the Java virtual machine

UnmappableCharacterException - Where a line contains a character that cannot be mapped to an output byte sequence

IOException - If an I/O error occurs

writeLines

public static void writeLines(OutputStream out,
                              Iterable<String> lines)
                       throws IOException

Writes the given lines of text to the specified output stream. The characters in each line are encoded into bytes using the underlying platform's default charset.

Parameters:

out - The output stream

lines - The list of lines to write (in order)

Throws:

UnmappableCharacterException - Where a line contains a character that cannot be mapped to an output byte sequence

IOException - If an I/O error occurs