org.pfsw.file

Class NamedWriter

java.lang.Object

org.pfsw.file.NamedCloseable

org.pfsw.file.NamedWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class NamedWriter
extends NamedCloseable

A container for an Writer with an associated name.

Constructor Summary

Constructors

Constructor and Description
NamedWriter(java.lang.String name, java.io.Writer writer) Create a new instance with the given name associated to the given writer.

Method Summary

Modifier and Type	Method and Description
protected java.io.Closeable	getCloseable() Returns the closeable that is associated with the name defined in this class.
java.io.Writer	getWriter() Returns the underlying Writer (will never be null).
static NamedWriter	open(java.io.File file, java.nio.charset.Charset charset) Opens the provided file and returns the writer along with the file name.
static NamedWriter	open(java.lang.String filename, java.nio.charset.Charset charset) Opens the file specified by the given filename and returns the writer along with the file name.

Methods inherited from class org.pfsw.file.NamedCloseable

close, getName, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedWriter

public NamedWriter(java.lang.String name,
                   java.io.Writer writer)

Create a new instance with the given name associated to the given writer.

Parameters:

name - The name of the writer (must not be null).

writer - The writer to be associated with the name (must not be null).

Throws:

java.lang.IllegalArgumentException - If either name or writer is null.

Method Detail

open

public static NamedWriter open(java.io.File file,
                               java.nio.charset.Charset charset)
                        throws java.io.FileNotFoundException

Opens the provided file and returns the writer along with the file name.

Parameters:

file - The file to be opened (must not be null).

charset - The character encoding of the file.

Returns:

An object that contains the (normalized) absolute file name and the OutputStreamWriter on the just opened file.

Throws:

java.io.FileNotFoundException - If the provided file cannot be opened/created.

open

public static NamedWriter open(java.lang.String filename,
                               java.nio.charset.Charset charset)
                        throws java.io.FileNotFoundException

Opens the file specified by the given filename and returns the writer along with the file name.

Parameters:

filename - The file to be opened (must not be null).

charset - The character encoding of the file.

Returns:

An object that contains the (normalized) absolute file name and the OutputStreamWriter on the just opened file.

Throws:

java.io.FileNotFoundException - If a file with the given name cannot be opened/created.

getWriter

public java.io.Writer getWriter()

Returns the underlying Writer (will never be null).

getCloseable

protected java.io.Closeable getCloseable()

Description copied from class: NamedCloseable

Returns the closeable that is associated with the name defined in this class.

Specified by:

getCloseable in class NamedCloseable