org.pfsw.file

Class NamedOutputStream

java.lang.Object

org.pfsw.file.NamedCloseable

org.pfsw.file.NamedOutputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class NamedOutputStream
extends NamedCloseable

A container for an OutputStream with an associated name.

Constructor Summary

Constructors

Constructor and Description
NamedOutputStream(java.lang.String name, java.io.OutputStream stream) Create a new instance with the given name associated to the given output stream.

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.OutputStream	getOutputStream() Returns the underlying OutputStream (will never be null).
static NamedOutputStream	open(java.io.File file) Opens the provided file and returns the output stream along with the file name.
static NamedOutputStream	open(java.lang.String filename) Opens the file specified by the given filename and returns the output stream 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

NamedOutputStream

public NamedOutputStream(java.lang.String name,
                         java.io.OutputStream stream)

Create a new instance with the given name associated to the given output stream.

Parameters:

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

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

Throws:

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

Method Detail

open

public static NamedOutputStream open(java.io.File file)
                              throws java.io.FileNotFoundException

Opens the provided file and returns the output stream along with the file name.

Parameters:

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

Returns:

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

Throws:

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

open

public static NamedOutputStream open(java.lang.String filename)
                              throws java.io.FileNotFoundException

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

Parameters:

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

Returns:

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

Throws:

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

getOutputStream

public java.io.OutputStream getOutputStream()

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