org.apache.commons.io.input
Class CloseShieldInputStream

java.lang.Object
  extended by java.io.InputStream
      extended by java.io.FilterInputStream
          extended by org.apache.commons.io.input.ProxyInputStream
              extended by org.apache.commons.io.input.CloseShieldInputStream
All Implemented Interfaces:
Closeable

public class CloseShieldInputStream
extends ProxyInputStream

Proxy stream that prevents the underlying input stream from being closed.

This class is typically used in cases where an input stream needs to be passed to a component that wants to explicitly close the stream even if more input would still be available to other components.

Since:
Commons IO 1.4
Version:
$Id: CloseShieldInputStream.java 587913 2007-10-24 15:47:30Z niallp $

Field Summary
 
Fields inherited from class java.io.FilterInputStream
in
 
Constructor Summary
CloseShieldInputStream(InputStream in)
          Creates a proxy that shields the given input stream from being closed.
 
Method Summary
 void close()
          Replaces the underlying input stream with a ClosedInputStream sentinel.
 
Methods inherited from class org.apache.commons.io.input.ProxyInputStream
available, mark, markSupported, read, read, read, reset, skip
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CloseShieldInputStream

public CloseShieldInputStream(InputStream in)
Creates a proxy that shields the given input stream from being closed.

Parameters:
in - underlying input stream
Method Detail

close

public void close()
Replaces the underlying input stream with a ClosedInputStream sentinel. The original input stream will remain open, but this proxy will appear closed.

Specified by:
close in interface Closeable
Overrides:
close in class ProxyInputStream


Copyright 2002-2008 The Apache Software Foundation. All Rights Reserved.