Package fr.gouv.vitam.common.storage.swift

Class VitamAutoCloseInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.commons.io.input.ProxyInputStream

fr.gouv.vitam.common.storage.swift.VitamAutoCloseInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class VitamAutoCloseInputStream
extends org.apache.commons.io.input.ProxyInputStream

InputStream used to prevent consume an already consumed stream

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	VitamAutoCloseInputStream.AlreadyConsumedInputStream

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
VitamAutoCloseInputStream(InputStream in)	Creates an automatically closing proxy for the given input stream.

Method Summary

Modifier and Type	Method	Description
protected void	afterRead(int n)	Automatically closes the stream if the end of stream was reached.
void	close()	Closes the underlying input stream and replaces the reference to it with a ClosedInputStream instance.
protected void	finalize()	Ensures that the stream is closed before it gets garbage-collected.

Methods inherited from class org.apache.commons.io.input.ProxyInputStream

available, beforeRead, handleIOException, mark, markSupported, read, read, read, reset, skip, unwrap

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

VitamAutoCloseInputStream

public VitamAutoCloseInputStream(InputStream in)

Creates an automatically closing proxy for the given input stream.

Parameters:

in - underlying input stream

Method Details

close

public void close()
           throws IOException

Closes the underlying input stream and replaces the reference to it with a ClosedInputStream instance.

This method is automatically called by the read methods when the end of input has been reached.

Note that it is safe to call this method any number of times. The original underlying input stream is closed and discarded only once when this method is first called.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class org.apache.commons.io.input.ProxyInputStream

Throws:

IOException - if the underlying input stream can not be closed

afterRead

protected void afterRead(int n)
                  throws IOException

Automatically closes the stream if the end of stream was reached.

Overrides:

afterRead in class org.apache.commons.io.input.ProxyInputStream

Parameters:

n - number of bytes read, or -1 if no more bytes are available

Throws:

IOException - if the stream could not be closed

Since:

2.0

finalize

protected void finalize()
                 throws Throwable

Ensures that the stream is closed before it gets garbage-collected. As mentioned in close(), this is a no-op if the stream has already been closed.

Overrides:

finalize in class Object

Throws:

Throwable - if an error occurs