net.sf.mmm.util.io.api

Interface DetectorInputStream

All Superinterfaces:

DetectorStream

All Known Implementing Classes:

ProcessableDetectorInputStream

public interface DetectorInputStream
extends DetectorStream

This is the interface for a DetectorStream that wraps an InputStream.

Since:

1.0.2

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
InputStream	getStream() This method gets the wrapped stream.

Methods inherited from interface net.sf.mmm.util.io.api.DetectorStream

getMetadata, isDone

Method Detail

getStream

InputStream getStream()

This method gets the wrapped stream. After this stream is read to the end, the metadata can be retrieved. This method is a simple getter - it will always return the same stream object.
This returned wrapper stream has the following limitations:

• skipping is NOT permitted.
• mark is NOT supported.
• You need to read/write your data completely (at least until the detection is done) in order to get the complete metadata.

Returns:

the wrapper stream.