org.pfsw.file

Class NamedReader

java.lang.Object

org.pfsw.file.NamedCloseable

org.pfsw.file.NamedReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class NamedReader
extends NamedCloseable

A container for a Reader with an associated name.

Constructor Summary

Constructors

Constructor and Description
NamedReader(java.lang.String name, java.io.Reader reader) Create a new instance with the given name associated to the given reader.

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.Reader	getReader() Returns the underlying Reader (will never be null).
static NamedReader	open(java.io.File file, java.nio.charset.Charset charset) Opens the provided file and returns the reader along with the file name.
static NamedReader	open(java.lang.String filename, java.nio.charset.Charset charset) Opens the file specified by the given filename and returns the reader 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

NamedReader

public NamedReader(java.lang.String name,
                   java.io.Reader reader)

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

Parameters:

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

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

Throws:

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

Method Detail

open

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

Opens the provided file and returns the reader 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 InputStreamReader on the just opened file.

Throws:

java.io.FileNotFoundException - If the provided file cannot be found.

open

public static NamedReader 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 reader 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 InputStreamReader on the just opened file.

Throws:

java.io.FileNotFoundException - If a file with the given name cannot be found.

getReader

public java.io.Reader getReader()

Returns the underlying Reader (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