org.apache.commons.io.input

Class ObservableInputStream

    • Constructor Detail

      • ObservableInputStream

        public ObservableInputStream(InputStream inputStream)
        Creates a new ObservableInputStream for the given InputStream.
        Parameters:
        inputStream - the input stream to observe.
      • ObservableInputStream

        public ObservableInputStream(InputStream inputStream,
                                     ObservableInputStream.Observer... observers)
        Creates a new ObservableInputStream for the given InputStream.
        Parameters:
        inputStream - the input stream to observe.
        observers - List of observer callbacks.
        Since:
        2.9.0
    • Method Detail

      • consume

        public void consume()
                     throws IOException
        Reads all data from the underlying InputStream, while notifying the observers.
        Throws:
        IOException - The underlying InputStream, or either of the observers has thrown an exception.
      • getObservers

        public List<ObservableInputStream.Observer> getObservers()
        Gets all currently registered observers.
        Returns:
        a list of the currently registered observers.
        Since:
        2.9.0
      • noteDataByte

        protected void noteDataByte(int value)
                             throws IOException
        Notifies the observers by invoking ObservableInputStream.Observer.data(int) with the given arguments.
        Parameters:
        value - Passed to the observers.
        Throws:
        IOException - Some observer has thrown an exception, which is being passed down.
      • noteDataBytes

        protected void noteDataBytes(byte[] buffer,
                                     int offset,
                                     int length)
                              throws IOException
        Notifies the observers by invoking ObservableInputStream.Observer.data(byte[],int,int) with the given arguments.
        Parameters:
        buffer - Passed to the observers.
        offset - Passed to the observers.
        length - Passed to the observers.
        Throws:
        IOException - Some observer has thrown an exception, which is being passed down.
      • read

        public int read(byte[] buffer)
                 throws IOException
        Description copied from class: ProxyInputStream
        Invokes the delegate's read(byte[]) method.
        Overrides:
        read in class  ProxyInputStream
        Parameters:
        buffer - the buffer to read the bytes into
        Returns:
        the number of bytes read or EOF if the end of stream
        Throws:
        IOException - if an I/O error occurs.
      • read

        public int read(byte[] buffer,
                        int offset,
                        int length)
                 throws IOException
        Description copied from class: ProxyInputStream
        Invokes the delegate's read(byte[], int, int) method.
        Overrides:
        read in class  ProxyInputStream
        Parameters:
        buffer - the buffer to read the bytes into
        offset - The start offset
        length - The number of bytes to read
        Returns:
        the number of bytes read or -1 if the end of stream
        Throws:
        IOException - if an I/O error occurs.
      • removeAllObservers

        public void removeAllObservers()
        Removes all Observers.

Copyright © 2002–2021 The Apache Software Foundation. All rights reserved.