Interface OneShotContent

All Superinterfaces:

AutoCloseable

public interface OneShotContent
extends AutoCloseable

Provider-independent one-shot streaming input.

A one-shot input is not repeatable and therefore must be staged before signing recovery, canonical comparison, postcondition validation or publication that needs another pass. The returned stream is owned by the caller. Implementations must reject a second call to openStream().

Method Summary

Modifier and Type	Method	Description
void	close()	Releases the source.
OptionalLong	length()	Returns the known source length when available.
InputStream	openStream()	Opens the only sequential reader.

Method Details

openStream

InputStream openStream()
                throws IOException

Opens the only sequential reader.

Returns:

content stream

Throws:

IOException - if the source cannot be opened

IllegalStateException - if the source was already opened

length

OptionalLong length()

Returns the known source length when available.

Returns:

non-negative length or empty

close

void close()
    throws IOException

Releases the source.

Specified by:

close in interface AutoCloseable

Throws:

IOException - if cleanup fails