DecoratingInputStream (TrueCommons I/O 2.3.4 API)

java.lang.Object
- java.io.InputStream
- - net.java.truecommons.io.DecoratingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

DisconnectingInputStream, LockInputStream
```
public abstract class DecoratingInputStream
extends InputStream
```
An abstract decorator for an input stream. This class is a clean room alternative to FilterInputStream.

Author:

Christian Schlichtherle

See Also:
DecoratingOutputStream

Field Summary

Fields
Modifier and Type Field and Description

protected InputStream in
The nullable decorated input stream.

Fields
Modifier and Type	Field and Description
`protected InputStream`	`in` The nullable decorated input stream.

Constructor Summary

Constructors
Modifier Constructor and Description

protected DecoratingInputStream()

protected DecoratingInputStream(InputStream in)

Constructors
Modifier	Constructor and Description
`protected`	`DecoratingInputStream()`
`protected`	`DecoratingInputStream(InputStream in)`

Method Summary

Methods
Modifier and Type	Method and 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)`
`String`	`toString()` Returns a string representation of this object for debugging and logging purposes.

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

- Field Detail
  - in
```
@Nullable
@WillCloseWhenClosed
protected InputStream in
```
    The nullable decorated input stream.
- Constructor Detail
  - DecoratingInputStream
```
protected DecoratingInputStream()
```
  - DecoratingInputStream
```
protected DecoratingInputStream(@WillCloseWhenClosed
                     InputStream in)
```
- Method Detail
  - available
```
public int available()
              throws IOException
```
    Overrides:
    
    available in class InputStream
    
    Throws:
    
    IOException
  - close
```
@DischargesObligation
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class InputStream
    
    Throws:
    
    IOException
  - mark
```
public void mark(int readlimit)
```
    Overrides:
    
    mark in class InputStream
  - markSupported
```
public boolean markSupported()
```
    Overrides:
    
    markSupported in class InputStream
  - read
```
public int read()
         throws IOException
```
    Specified by:
    
    read in class InputStream
    
    Throws:
    
    IOException
  - read
```
public final int read(byte[] b)
               throws IOException
```
    Overrides:
    
    read in class InputStream
    
    Throws:
    
    IOException
  - read
```
public int read(byte[] b,
       int off,
       int len)
         throws IOException
```
    Overrides:
    
    read in class InputStream
    
    Throws:
    
    IOException
  - reset
```
public void reset()
           throws IOException
```
    Overrides:
    
    reset in class InputStream
    
    Throws:
    
    IOException
  - skip
```
public long skip(long n)
          throws IOException
```
    Overrides:
    
    skip in class InputStream
    
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Returns a string representation of this object for debugging and logging purposes.
    
    Overrides:
    
    toString in class Object

Class DecoratingInputStream

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

in

Constructor Detail

DecoratingInputStream

DecoratingInputStream

Method Detail

available

close

mark

markSupported

read

read

read

reset

skip

toString