LockInputStream (TrueCommons I/O 2.3.4 API)

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

All Implemented Interfaces:

Closeable, AutoCloseable
```
@ThreadSafe
public class LockInputStream
extends DecoratingInputStream
```
A decorator which protects all access to its input stream via a Lock.

Author:

Christian Schlichtherle

See Also:
LockOutputStream

Field Summary
- Fields inherited from class net.java.truecommons.io.DecoratingInputStream
  in

Constructor Summary

Constructors
Modifier Constructor and Description

protected LockInputStream(Lock lock)

LockInputStream(Lock lock, InputStream in)

Constructors
Modifier	Constructor and Description
`protected`	`LockInputStream(Lock lock)`
	`LockInputStream(Lock lock, 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 off, int len)`
`void`	`reset()`
`long`	`skip(long n)`

Methods inherited from class net.java.truecommons.io.DecoratingInputStream
read, toString

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

- Constructor Detail
  - LockInputStream
```
protected LockInputStream(Lock lock)
```
  - LockInputStream
```
public LockInputStream(Lock lock,
               @WillCloseWhenClosed
               InputStream in)
```
- Method Detail
  - available
```
public int available()
              throws IOException
```
    Overrides:
    
    available in class DecoratingInputStream
    
    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 DecoratingInputStream
    
    Throws:
    
    IOException
  - mark
```
public void mark(int readlimit)
```
    Overrides:
    
    mark in class DecoratingInputStream
  - markSupported
```
public boolean markSupported()
```
    Overrides:
    
    markSupported in class DecoratingInputStream
  - read
```
public int read()
         throws IOException
```
    Overrides:
    
    read in class DecoratingInputStream
    
    Throws:
    
    IOException
  - read
```
public int read(byte[] b,
       int off,
       int len)
         throws IOException
```
    Overrides:
    
    read in class DecoratingInputStream
    
    Throws:
    
    IOException
  - reset
```
public void reset()
           throws IOException
```
    Overrides:
    
    reset in class DecoratingInputStream
    
    Throws:
    
    IOException
  - skip
```
public long skip(long n)
          throws IOException
```
    Overrides:
    
    skip in class DecoratingInputStream
    
    Throws:
    
    IOException

Class LockInputStream

Field Summary

Fields inherited from class net.java.truecommons.io.DecoratingInputStream

Constructor Summary

Method Summary

Methods inherited from class net.java.truecommons.io.DecoratingInputStream

Methods inherited from class java.lang.Object

Constructor Detail

LockInputStream

LockInputStream

Method Detail

available

close

mark

markSupported

read

read

reset

skip