Class NshNonBlockingInputStreamAdapter

java.lang.Object
java.io.InputStream
java.io.FilterInputStream
net.thevpc.nsh.util.NshNonBlockingInputStreamAdapter
All Implemented Interfaces:
Closeable, AutoCloseable, NshNonBlockingInputStream
public class NshNonBlockingInputStreamAdapter extends FilterInputStream implements NshNonBlockingInputStream

  • Constructor Details

    • NshNonBlockingInputStreamAdapter

      public NshNonBlockingInputStreamAdapter(String name, InputStream in)

  • Method Details

    • read

      public int read() throws IOException
      Description copied from interface: NshNonBlockingInputStream
      Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

      A subclass must provide an implementation of this method.

      Specified by:
      read in interface NshNonBlockingInputStream
      Overrides:
      read in class FilterInputStream
      Returns:
      the next byte of data, or -1 if the end of the stream is reached.
      Throws:
      IOException - if an I/O error occurs.

    • read

      public int read(byte[] b) throws IOException
      Description copied from interface: NshNonBlockingInputStream
      Reads some number of bytes from the input stream and stores them into the buffer array b. The number of bytes actually readAll is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown.

      If the length of b is zero, then no bytes are readAll and 0 is returned; otherwise, there is an attempt to readAll at least one byte. If no byte is available because the stream is at the end of the file, the value -1 is returned; otherwise, at least one byte is readAll and stored into b.

      The first byte readAll is stored into element b[0], the next one into b[1], and so on. The number of bytes readAll is, at most, equal to the length of b. Let k be the number of bytes actually readAll; these bytes will be stored in elements b[0] through b[k-1], leaving elements b[k] through b[b.length-1] unaffected.

      The readAll(b) method for class InputStream has the same effect as: 

       readAll(b, 0, b.length)
      Specified by:
      read in interface NshNonBlockingInputStream
      Overrides:
      read in class FilterInputStream
      Parameters:
      b - the buffer into which the data is readAll.
      Returns:
      the total number of bytes readAll into the buffer, or -1 if there is no more data because the end of the stream has been reached.
      Throws:
      IOException - If the first byte cannot be readAll for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.
      See Also:

    • read

      public int read(byte[] b, int off, int len) throws IOException
      Description copied from interface: NshNonBlockingInputStream
      Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to readAll as many as len bytes, but a smaller number may be readAll. The number of bytes actually readAll is returned as an integer.

      This method blocks until input data is available, end of file is detected, or an exception is thrown.

      If len is zero, then no bytes are readAll and 0 is returned; otherwise, there is an attempt to readAll at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is readAll and stored into b.

      The first byte readAll is stored into element b[off], the next one into b[off+1], and so on. The number of bytes readAll is, at most, equal to len. Let k be the number of bytes actually readAll; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

      In every case, elements b[0] through b[off] and elements b[off+len] through b[b.length-1] are unaffected.

      The readAll(b, off, len) method for class InputStream simply calls the method readAll() repeatedly. If the first such call results in an IOException, that exception is returned from the call to the readAll(b, off, len) method. If any subsequent call to readAll() results in a IOException, the exception is caught and treated as if it were end of file; the bytes readAll up to that point are stored into b and the number of bytes readAll before the exception occurred is returned. The default implementation of this method blocks until the requested amount of input data len has been readAll, end of file is detected, or an exception is thrown. Subclasses are encouraged to provide a more efficient implementation of this method.

      Specified by:
      read in interface NshNonBlockingInputStream
      Overrides:
      read in class FilterInputStream
      Parameters:
      b - the buffer into which the data is readAll.
      off - the start offset in array b at which the data is written.
      len - the maximum number of bytes to readAll.
      Returns:
      the total number of bytes readAll into the buffer, or -1 if there is no more data because the end of the stream has been reached.
      Throws:
      IOException - If the first byte cannot be readAll for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.
      See Also:

    • skip

      public long skip(long n) throws IOException
      Description copied from interface: NshNonBlockingInputStream
      Skips over and discards n bytes of data from this input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If n is negative, the skip method for class InputStream always returns 0, and no bytes are skipped. Subclasses may handle the negative value differently.

      The skip method of this class creates a byte array and then repeatedly reads into it until n bytes have been readAll or the end of the stream has been reached. Subclasses are encouraged to provide a more efficient implementation of this method. For instance, the implementation may depend on the ability to seek.

      Specified by:
      skip in interface NshNonBlockingInputStream
      Overrides:
      skip in class FilterInputStream
      Parameters:
      n - the number of bytes to be skipped.
      Returns:
      the actual number of bytes skipped.
      Throws:
      IOException - if the stream does not support seek, or if some other I/O error occurs.

    • available

      public int available() throws IOException
      Description copied from interface: NshNonBlockingInputStream
      Returns an estimate of the number of bytes that can be readAll (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. The next invocation might be the same thread or another thread. A single readAll or skip of this many bytes will not block, but may readAll or skip fewer bytes.

      Note that while some implementations of InputStream will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream.

      A subclass' implementation of this method may choose to throw an IOException if this input stream has been closed by invoking the NshNonBlockingInputStream.close() method.

      The available method for class InputStream always returns 0.

      This method should be overridden by subclasses.

      Specified by:
      available in interface NshNonBlockingInputStream
      Overrides:
      available in class FilterInputStream
      Returns:
      an estimate of the number of bytes that can be readAll (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream.
      Throws:
      IOException - if an I/O error occurs.

    • readNonBlocking

      public int readNonBlocking(byte[] b, long timeout) throws IOException
      Specified by:
      readNonBlocking in interface NshNonBlockingInputStream
      Throws:
      IOException

    • readNonBlocking

      public int readNonBlocking(byte[] b, int off, int len, long timeout) throws IOException
      Specified by:
      readNonBlocking in interface NshNonBlockingInputStream
      Throws:
      IOException

    • noMoreBytes

      public void noMoreBytes()
      Specified by:
      noMoreBytes in interface NshNonBlockingInputStream

    • hasMoreBytes

      public boolean hasMoreBytes()
      Specified by:
      hasMoreBytes in interface NshNonBlockingInputStream

    • close

      public void close() throws IOException
      Description copied from interface: NshNonBlockingInputStream
      Closes this input stream and releases any system resources associated with the stream.

      The close method of InputStream does nothing.

      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in interface NshNonBlockingInputStream
      Overrides:
      close in class FilterInputStream
      Throws:
      IOException - if an I/O error occurs.