net.sf.mmm.util.io.impl
Class ProcessableDetectorInputStream

java.lang.Object
  net.sf.mmm.util.io.base.AbstractDetectorStream
      net.sf.mmm.util.io.impl.ProcessableDetectorStream
          net.sf.mmm.util.io.impl.ProcessableDetectorInputStream

All Implemented Interfaces:

DetectorInputStream, DetectorStream

public class ProcessableDetectorInputStream
extends ProcessableDetectorStream
implements DetectorInputStream

This is the implementation of the DetectorOutputStream.

Since:

1.1.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

protected class

ProcessableDetectorInputStream.WrapperInputStream This inner class is the actual wrapper stream.

Field Summary

private ProcessableDetectorInputStream.WrapperInputStream

wrapperInputStream

Constructor Summary

ProcessableDetectorInputStream(InputStream inputStream, Map<String,Object> mutableMetadata, AbstractDetectorStreamProvider provider)
The constructor.

Method Summary

InputStream

getStream() This method gets the wrapped stream.

Methods inherited from class net.sf.mmm.util.io.impl.ProcessableDetectorStream

getByteArrayPool, initialize, processInternal

Methods inherited from class net.sf.mmm.util.io.base.AbstractDetectorStream

getMetadata, getMutableMetadata, isDone, setDone

Methods inherited from class java.lang.Object

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

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

getMetadata, isDone

Field Detail

wrapperInputStream

private final ProcessableDetectorInputStream.WrapperInputStream wrapperInputStream

See Also:

getStream()

Constructor Detail

ProcessableDetectorInputStream

public ProcessableDetectorInputStream(InputStream inputStream,
                                      Map<String,Object> mutableMetadata,
                                      AbstractDetectorStreamProvider provider)

The constructor.

Parameters:

inputStream - is the raw ProcessableDetectorInputStream.WrapperInputStream to warp.

mutableMetadata - is the initial mutable metadata.

provider - is the DetectorStreamProvider creating this instance.

Method Detail

getStream

public 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.

Specified by:

getStream in interface DetectorInputStream

Returns:

the wrapper stream.