org.cryptacular.io

Class FileResource

java.lang.Object

org.cryptacular.io.FileResource

All Implemented Interfaces:

Resource

public class FileResource
extends java.lang.Object
implements Resource

Resource that produces a buffered FileInputStream from a file.

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.File	file Underlying file resource.

Constructor Summary

Constructors

Constructor and Description
FileResource(java.io.File file) Creates a new file resource.

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	getInputStream() Gets an input stream around the resource.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

file

private java.io.File file

Underlying file resource.

Constructor Detail

FileResource

public FileResource(java.io.File file)

Creates a new file resource.

Parameters:

file - Non-null file.

Method Detail

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Description copied from interface: Resource

Gets an input stream around the resource. Callers of this method are responsible for resource cleanup; it should be sufficient to simply call InputStream.close() unless otherwise noted.

Implementers should produce a new instance on every call to this method to provide for thread-safe usage patterns on a shared resource.

Specified by:

getInputStream in interface Resource

Returns:

Input stream around underlying resource, e.g. file, remote resource (URI), etc.

Throws:

java.io.IOException - On IO errors.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object