ReplayInputStream (org.refcodes:refcodes-io 2.2.0 API)

java.lang.Object
- java.io.InputStream
- - org.refcodes.io.ReplayInputStream

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class ReplayInputStream
extends InputStream
```
The ReplayInputStream wraps an InputStream adding mark(int), markSupported() as well as reset() functionality, similar to the BufferedInputStream. In contrast to the BufferedInputStream only the bytes actually read (by an application) are buffered, preventing it to hang as the BufferedInputStream would do when it tries to load a buffer of predefined size from (e.g. a serial TTY/COM port) InputStream which blocks till the requested data is actually available, making the whole application to "hang" (even though just one byte was to be read). The ReplayInputStream always uses its own mark(int), markSupported() as well as reset() implementations even if the wrapped InputStream (such as the BufferedInputStream supports mark(int) and reset()!

Constructor Summary

Constructors
Constructor Description

ReplayInputStream(InputStream aInputStream)
Decorates the provided InputStream with mark(int), markSupported() as well as reset() functionality

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()`
`void`	`reset()`

Methods inherited from class java.io.InputStream
nullInputStream, read, read, readAllBytes, readNBytes, readNBytes, skip, transferTo

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ReplayInputStream
```
public ReplayInputStream(InputStream aInputStream)
```
    Decorates the provided InputStream with mark(int), markSupported() as well as reset() functionality
    
    Parameters:
    
    aInputStream - The InputStream to be decorated accordingly.
- Method Detail
  - read
```
public int read()
         throws IOException
```
    Specified by:
    
    read in class InputStream
    
    Throws:
    
    IOException
  - available
```
public int available()
              throws IOException
```
    Overrides:
    
    available in class InputStream
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
    
    Overrides:
    
    close in class InputStream
    
    Throws:
    
    IOException
  - mark
```
public void mark(int readlimit)
```
    Overrides:
    
    mark in class InputStream
  - reset
```
public void reset()
           throws IOException
```
    Overrides:
    
    reset in class InputStream
    
    Throws:
    
    IOException
  - markSupported
```
public boolean markSupported()
```
    Overrides:
    
    markSupported in class InputStream