Package org.apache.jackrabbit.vault.util

Class InputStreamPump

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    public class InputStreamPump
extends java.io.InputStream
    An input stream pump feeds a InputStreamPump.Pump in a dedicated thread with the input read from the given input stream. This is similar to a TeeInputStream but leverages PipedInputStream and PipedOutputStream and can execute additional tasks in the additional thread consuming the PipedInputStream. Only after calling close() the PipedInputStream has been fully consumed (as it waits for the pump's thread to complete).
    See Also:
    MemoryArchive

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static interface  InputStreamPump.Pump  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      int available()  
      void close()  
      java.lang.Exception getError()
      Deprecated.
      Rather call close(), as otherwise this might be called too early (before the thread finished).
      void mark​(int readlimit)  
      boolean markSupported()  
      int read()  
      int read​(byte[] b)  
      int read​(byte[] b, int off, int len)  
      void reset()  
      long skip​(long n)  

      • Methods inherited from class java.io.InputStream

        nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • InputStreamPump

        public InputStreamPump​(java.io.InputStream source,
                       InputStreamPump.Pump pump)
                throws java.io.IOException
        Throws:
        java.io.IOException

    • Method Detail

      • getError

        @Deprecated
public java.lang.Exception getError()
        Deprecated.
        Rather call close(), as otherwise this might be called too early (before the thread finished). close() will automatically wrap the potential exception from the pump in an IOException and throws it as well
        Returns:
        exception which has occurred in the pump thread or null.

      • read

        public int read()
         throws java.io.IOException
        Specified by:
        read in class java.io.InputStream
        Throws:
        java.io.IOException

      • read

        public int read​(byte[] b)
         throws java.io.IOException
        Overrides:
        read in class java.io.InputStream
        Throws:
        java.io.IOException

      • read

        public int read​(byte[] b,
                int off,
                int len)
         throws java.io.IOException
        Overrides:
        read in class java.io.InputStream
        Throws:
        java.io.IOException

      • skip

        public long skip​(long n)
          throws java.io.IOException
        Overrides:
        skip in class java.io.InputStream
        Throws:
        java.io.IOException

      • available

        public int available()
              throws java.io.IOException
        Overrides:
        available in class java.io.InputStream
        Throws:
        java.io.IOException

      • close

        public void close()
           throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class java.io.InputStream
        Throws:
        java.io.IOException

      • mark

        public void mark​(int readlimit)
        Overrides:
        mark in class java.io.InputStream

      • reset

        public void reset()
           throws java.io.IOException
        Overrides:
        reset in class java.io.InputStream
        Throws:
        java.io.IOException

      • markSupported

        public boolean markSupported()
        Overrides:
        markSupported in class java.io.InputStream