com.asakusafw.windgate.stream

Class OutputStreamProvider

java.lang.Object

com.asakusafw.windgate.stream.OutputStreamProvider

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

FileOutputStreamProvider

public abstract class OutputStreamProvider
extends Object
implements Closeable

Provides OutputStreams.

Since:

0.2.4

Constructor Summary

Constructors

Constructor and Description
OutputStreamProvider()

Method Summary

Modifier and Type	Method and Description
abstract String	getCurrentPath() Returns the path about the current stream.
long	getDesiredStreamSize() Returns the desired each stream size.
abstract void	next() Advances the current stream to the next one.
abstract CountingOutputStream	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

OutputStreamProvider

public OutputStreamProvider()

Method Detail

getDesiredStreamSize

public long getDesiredStreamSize()

Returns the desired each stream size. If the client write data to a stream over this size, the client must must use the next() stream instead current one.

Returns:

the desired stream size, or 0 to unlimited (default: 0)

Throws:

IllegalArgumentException - if some parameters were null

next

public abstract void next()
                   throws IOException

Advances the current stream to the next one. Note that the current stream should be closed by the client.

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 CountingOutputStream 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