com.asakusafw.windgate.stream

Class InputStreamProvider

java.lang.Object

com.asakusafw.windgate.stream.InputStreamProvider

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

FileInputStreamProvider

public abstract class InputStreamProvider
extends Object
implements Closeable

Provides InputStreams.

Since:

0.2.4

Constructor Summary

Constructors

Constructor and Description
InputStreamProvider()

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

InputStreamProvider

public InputStreamProvider()

Method Detail

next

public abstract boolean next()
                      throws IOException

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.

Returns:

true if the next InputStream exists, otherwise false.

Throws:

IOException - if failed to obtain next stream

getCurrentPath

public abstract String getCurrentPath()

Returns the path about the current stream.

Returns:

the path

Throws:

IllegalStateException - if the current stream is not prepared

openStream

public abstract CountingInputStream openStream()
                                        throws IOException

Returns the current stream.

Returns:

the opened stream

Throws:

IOException - if failed to obtain the current stream

IllegalStateException - if the current stream is not prepared