Class CloseShieldReader

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable

    public class CloseShieldReader
    extends ProxyReader
    Proxy reader that prevents the underlying reader from being closed.

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

    Since:
    2.7
    • Constructor Summary

      Constructors 
      Constructor Description
      CloseShieldReader​(java.io.Reader reader)
      Deprecated.
      Using this constructor prevents IDEs from warning if the underlying reader is never closed.
    • Constructor Detail

      • CloseShieldReader

        @Deprecated
        public CloseShieldReader​(java.io.Reader reader)
        Deprecated.
        Using this constructor prevents IDEs from warning if the underlying reader is never closed. Use wrap(Reader) instead.
        Creates a proxy that shields the given reader from being closed.
        Parameters:
        reader - underlying reader
    • Method Detail

      • wrap

        public static CloseShieldReader wrap​(java.io.Reader reader)
        Creates a proxy that shields the given reader from being closed.
        Parameters:
        reader - the reader to wrap
        Returns:
        the created proxy
        Since:
        2.9.0
      • close

        public void close()
        Replaces the underlying reader with a ClosedReader sentinel. The original reader will remain open, but this proxy will appear closed.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class ProxyReader