broadwick.io

Class FileOutput

java.lang.Object

broadwick.io.FileOutput

All Implemented Interfaces:

AutoCloseable

public class FileOutput
extends Object
implements AutoCloseable

Simple interface to printing values to a file. It simply wraps the java io classes to simplify the output of data.

Field Summary

Fields

Modifier and Type	Field and Description
private BufferedOutputStream	buffer
private static String	DEFAULT_ENCODING
private String	fileEncoding

Constructor Summary

Constructors

Constructor and Description
FileOutput() Create a null file output object similar to writing to /dev/null.
FileOutput(String dataFileName) Create a file with the given name.
FileOutput(String dataFileName, boolean addVersion) Create a file with the given name.
FileOutput(String dataFileName, boolean addVersion, boolean append) Create a file with the given name.
FileOutput(String dataFileName, boolean addVersion, boolean append, String encoding) Create a file with the given name.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush() Flushes the file stream.
static void	saveToFile(String dataFileName, String data, boolean addVersion) Save data in the form of a string to a named file.
static void	saveToFile(String dataFileName, String format, boolean addVersion, Object... args) Save data in the form of a string to a named file.
void	write(String str) Write the string to the file stream.
String	write(String format, Object... args) Writes a formatted string to the file stream.

Methods inherited from class java.lang.Object

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

Field Detail

buffer

private BufferedOutputStream buffer

fileEncoding

private String fileEncoding

DEFAULT_ENCODING

private static final String DEFAULT_ENCODING

See Also:

Constant Field Values

Constructor Detail

FileOutput

public FileOutput()

Create a null file output object similar to writing to /dev/null. This allows for empty FileOutput objects to be used without throwing NullPointerExceptions.

FileOutput

public FileOutput(String dataFileName)

Create a file with the given name.

Parameters:

dataFileName - the name of the file.

FileOutput

public FileOutput(String dataFileName,
                  boolean addVersion)

Create a file with the given name.

Parameters:

dataFileName - the name of the file.

addVersion - boolean that determines whether or not the project version number should be applied to the start of the file.

FileOutput

public FileOutput(String dataFileName,
                  boolean addVersion,
                  boolean append)

Create a file with the given name.

Parameters:

dataFileName - the name of the file.

addVersion - boolean that determines whether or not the project version number should be applied to the start of the file.

append - if true, then bytes will be written to the end of the file.

FileOutput

public FileOutput(String dataFileName,
                  boolean addVersion,
                  boolean append,
                  String encoding)

Create a file with the given name.

Parameters:

dataFileName - the name of the file.

addVersion - boolean that determines whether or not the project version number should be applied to the start of the file.

append - if true, then bytes will be written to the end of the file.

encoding - the character encoding used in the file.

Method Detail

write

public final void write(String str)

Write the string to the file stream.

Parameters:

str - the string to write to the stream.

write

public final String write(String format,
                          Object... args)

Writes a formatted string to the file stream.

Parameters:

format - A format string as described in Format string syntax

args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by the Java Virtual Machine Specification

Returns:

the string written to the buffer.

close

public final void close()

Specified by:

close in interface AutoCloseable

flush

public final void flush()

Flushes the file stream.

saveToFile

public static void saveToFile(String dataFileName,
                              String data,
                              boolean addVersion)

Save data in the form of a string to a named file.

Parameters:

dataFileName - the name of the file in which the data is to be saved.

data - the data to be saved.

addVersion - add the project version number to the start of the file.

saveToFile

public static void saveToFile(String dataFileName,
                              String format,
                              boolean addVersion,
                              Object... args)

Save data in the form of a string to a named file.

Parameters:

dataFileName - the name of the file in which the data is to be saved.

format - A format string as described in Format string syntax

addVersion - add the project version number to the start of the file.

args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by the Java Virtual Machine Specification