Package org.apache.creadur.whisker.app.load

Class StreamableFileResource

java.lang.Object

org.apache.creadur.whisker.app.StreamableResource

org.apache.creadur.whisker.app.load.StreamableFileResource

public final class StreamableFileResource
extends StreamableResource

Streams the contents of a file.

Constructor Summary

Constructors

Constructor	Description
StreamableFileResource(File file)	Constructs an object that streams the file on demand.

Method Summary

Modifier and Type	Method	Description
InputStream	open()	Opens the file as an input stream.
String	toString()	A description suitable for diagnostics.

Methods inherited from class java.lang.Object

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

Constructor Details

StreamableFileResource

public StreamableFileResource(File file)

Constructs an object that streams the file on demand.

Parameters:

file - not null

Method Details

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()

A description suitable for diagnostics.

Overrides:

toString in class Object

Returns:

something suitable for diagnostics, not null