Class ConfigStream

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

    public class ConfigStream
    extends java.io.InputStream
    Stream wrapping or copying a generic InputStream for the ConfigRecognizer API. The purpose of this class is to make the provided InputStream resetable so that multiple ConfigRecognizer implementations can iterate over the stream. There are even basic InputStream implementations that don't support InputStream.reset() such as BufferedInputStream. If calling reset() on the provided implementation fails with an exception, this class reads the stream into a byte[] and delegates all InputStream method calls to a ByteArrayInputStream created with this byte[]. To prevent OOM issues, the size of this byte[] is limited to 4096 bytes. This limit can be configured in the constructor.
    See Also:
    ConfigRecognizer
    • Constructor Summary

      Constructors 
      Constructor Description
      ConfigStream​(java.io.InputStream configStream)  
      ConfigStream​(java.io.InputStream configStream, int readLimit)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int available()  
      void close()  
      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

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ConfigStream

        public ConfigStream​(java.io.InputStream configStream)
                     throws java.io.IOException
        Throws:
        java.io.IOException
      • ConfigStream

        public ConfigStream​(java.io.InputStream configStream,
                            int readLimit)
                     throws java.io.IOException
        Throws:
        java.io.IOException
    • Method Detail

      • 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