Class Bitstream.ByteInputStream

Method Details

• setStream

  public void setStream(InputStream stream)

  Description copied from interface: Bitstream.ByteStream

  Sets the underlying stream, without Bitstream.ByteStream.close()ing the previous one.

  Specified by:

  setStream in interface Bitstream.ByteStream<InputStream>

• getStream

  public InputStream getStream()

  Description copied from interface: Bitstream.ByteStream

  Returns the underlying stream

  Specified by:

  getStream in interface Bitstream.ByteStream<InputStream>

• close

  public void close() throws IOException

  Description copied from interface: Bitstream.ByteStream

  Closing the underlying stream, implies Bitstream.ByteStream.flush().

  Implementation will null the stream references, hence Bitstream.ByteStream.setStream(Object) must be called before re-using instance.

  Specified by:

  close in interface Bitstream.ByteStream<InputStream>

  Throws:

  IOException

• flush

  public void flush()

  Description copied from interface: Bitstream.ByteStream

  Synchronizes all underlying output stream operations, or do nothing.

  Specified by:

  flush in interface Bitstream.ByteStream<InputStream>

• canInput

  public boolean canInput()

  Description copied from interface: Bitstream.ByteStream

  Return true if stream can handle input, i.e. Bitstream.ByteStream.read().

  Specified by:

  canInput in interface Bitstream.ByteStream<InputStream>

• canOutput

  public boolean canOutput()

  Description copied from interface: Bitstream.ByteStream

  Return true if stream can handle output, i.e. Bitstream.ByteStream.write(byte)

  Specified by:

  canOutput in interface Bitstream.ByteStream<InputStream>

• position

  public long position()

  Description copied from interface: Bitstream.ByteStream

  Returns the byte position in the stream.

  Specified by:

  position in interface Bitstream.ByteStream<InputStream>

• position

  public long position(long newPosition) throws UnsupportedOperationException, IllegalArgumentException

  Description copied from interface: Bitstream.ByteStream

  Sets this stream's position.

  A set mark is cleared if > new position.

  Returns Bitstream.EOS is end-of-stream is reached, otherwise the new position.

  Known supporting implementation is Bitstream.ByteBufferStream and Bitstream.ByteArrayStream.

  Specified by:

  position in interface Bitstream.ByteStream<InputStream>

  Parameters:

  newPosition - The new positive position.

  Returns:

  The new set position or Bitstream.EOS if end-of-stream is reached.

  Throws:

  UnsupportedOperationException - if not supported, i.e. Bitstream.ByteInputStream or Bitstream.ByteOutputStream

  IllegalArgumentException - If the newPosition is negative

• skip

  public long skip(long n) throws IOException

  Description copied from interface: Bitstream.ByteStream

  It is implementation dependent, whether backward skip giving a negative number is supported or not.

  Specified by:

  skip in interface Bitstream.ByteStream<InputStream>

  Parameters:

  n - number of bytes to skip

  Returns:

  actual skipped bytes

  Throws:

  IOException

• mark

  public void mark(int readLimit)

  Description copied from interface: Bitstream.ByteStream

  Set markpos to current position, allowing the stream to be Bitstream.ByteStream.reset().

  Specified by:

  mark in interface Bitstream.ByteStream<InputStream>

• reset

  public void reset() throws IllegalStateException, IOException

  Description copied from interface: Bitstream.ByteStream

  Reset stream position to markpos as set via Bitstream.ByteStream.mark(int).

  markpos is kept, hence Bitstream.ByteStream.reset() can be called multiple times.

  Specified by:

  reset in interface Bitstream.ByteStream<InputStream>

  Throws:

  IllegalStateException - if markpos has not been set via Bitstream.ByteStream.mark(int) or reset operation failed.

  IOException - if reset operation failed.

• read

  public int read() throws IOException

  Description copied from interface: Bitstream.ByteStream

  Reads one byte from the stream.

  Returns Bitstream.EOS is end-of-stream is reached, otherwise the resulting value.

  Specified by:

  read in interface Bitstream.ByteStream<InputStream>

  Throws:

  IOException

• write

  public int write(byte val) throws UnsupportedOperationException

  Description copied from interface: Bitstream.ByteStream

  Writes one byte, to the stream.

  Returns Bitstream.EOS is end-of-stream is reached, otherwise the written value.

  Specified by:

  write in interface Bitstream.ByteStream<InputStream>

  Throws:

  UnsupportedOperationException - if not supported, i.e. if stream is not an output stream.