org.pfsw.file

Class NamedInputStream

java.lang.Object

org.pfsw.file.NamedCloseable

org.pfsw.file.NamedInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class NamedInputStream
extends NamedCloseable

A container for an InputStream with an associated name.

Constructor Summary

Constructors

Constructor and Description
NamedInputStream(java.lang.String name, java.io.InputStream stream) Create a new instance with the given name associated to the given input 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.InputStream	getInputStream() Returns the underlying InputStream (will never be null).
static NamedInputStream	open(java.io.File file) Opens the provided file and returns the input stream along with the file name.
static NamedInputStream	open(java.lang.String filename) Opens the file specified by the given filename and returns the input 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

NamedInputStream

public NamedInputStream(java.lang.String name,
                        java.io.InputStream stream)

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

Parameters:

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

stream - The input 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 NamedInputStream open(java.io.File file)
                             throws java.io.FileNotFoundException

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

Throws:

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

open

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

Opens the file specified by the given filename and returns the input 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 FileInputStream on the just opened file.

Throws:

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

getInputStream

public java.io.InputStream getInputStream()

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