com.asakusafw.windgate.stream.file

Class FileInputStreamProvider

java.lang.Object

com.asakusafw.windgate.stream.InputStreamProvider

com.asakusafw.windgate.stream.file.FileInputStreamProvider

All Implemented Interfaces:

Closeable, AutoCloseable

public class FileInputStreamProvider
extends InputStreamProvider

An implementation of InputStreamProvider using files.

Since:

0.2.4

Constructor Summary

Constructors

Constructor and Description
FileInputStreamProvider(File file) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	close()
String	getCurrentPath() Returns the path about the current stream.
boolean	next() Returns whether a next InputStream exists, and advances the current stream to the next one.
CountingInputStream	openStream() Returns the current stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileInputStreamProvider

public FileInputStreamProvider(File file)

Creates a new instance.

Parameters:

file - target file to open

Throws:

IllegalArgumentException - if some parameters were null

Method Detail

next

public boolean next()
             throws IOException

Description copied from class: InputStreamProvider

Returns whether a next InputStream exists, and advances the current stream to the next one. Note that the current stream should be closed by the client.

Specified by:

next in class InputStreamProvider

Returns:

true if the next InputStream exists, otherwise false.

Throws:

IOException - if failed to obtain next stream

getCurrentPath

public String getCurrentPath()

Description copied from class: InputStreamProvider

Returns the path about the current stream.

Specified by:

getCurrentPath in class InputStreamProvider

Returns:

the path

openStream

public CountingInputStream openStream()
                               throws IOException

Description copied from class: InputStreamProvider

Returns the current stream.

Specified by:

openStream in class InputStreamProvider

Returns:

the opened stream

Throws:

IOException - if failed to obtain the current stream

close

public void close()