org.apache.creadur.whisker.app.load

Class StreamableFileNameResource

java.lang.Object

org.apache.creadur.whisker.app.StreamableResource

org.apache.creadur.whisker.app.load.StreamableFileNameResource

public final class StreamableFileNameResource
extends StreamableResource

Streams, on demand, the contents of a file identified by a full file name, including path.

Constructor Summary

Constructors

Constructor and Description
StreamableFileNameResource(String fileName) Constructs an instance that streams the resource identified by name on demand.

Method Summary

Methods

Modifier and Type	Method and Description
String	getFileName() Gets the file name of the resource to be streamed.
InputStream	open() Opens the file as an input stream.
String	toString() Suitable for logging.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamableFileNameResource

public StreamableFileNameResource(String fileName)

Constructs an instance that streams the resource identified by name on demand.

Parameters:

fileName - full file name, including path, of the resource to be streamed on demand, not null

Method Detail

getFileName

public String getFileName()

Gets the file name of the resource to be streamed.

Returns:

full file name, not null

open

public InputStream open()
                 throws IOException

Opens the file as an input stream.

Specified by:

open in class StreamableResource

Returns:

not null

Throws:

IOException - when resource cannot be opened

See Also:

StreamableResource.open()

toString

public String toString()

Suitable for logging.

Overrides:

toString in class Object

Returns:

a description