ChannelInputStream (TrueCommons I/O 2.3.4 API)

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

All Implemented Interfaces:

Closeable, AutoCloseable
```
@NotThreadSafe
@CleanupObligation
public class ChannelInputStream
extends InputStream
```
Adapts a SeekableByteChannel to an input stream. This stream supports marking unless the adapted channel fails to set its position in markSupported().

Author:

Christian Schlichtherle

See Also:
ChannelOutputStream

Field Summary

Fields
Modifier and Type Field and Description

protected SeekableByteChannel channel
The adapted nullable seekable byte channel.

Fields
Modifier and Type	Field and Description
`protected SeekableByteChannel`	`channel` The adapted nullable seekable byte channel.

Constructor Summary

Constructors
Modifier Constructor and Description

protected ChannelInputStream()

ChannelInputStream(SeekableByteChannel channel)

Constructors
Modifier	Constructor and Description
`protected`	`ChannelInputStream()`
	`ChannelInputStream(SeekableByteChannel channel)`

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)`

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

Field Detail
- channel
```
@Nullable
protected SeekableByteChannel channel
```
  The adapted nullable seekable byte channel.

Constructor Detail

ChannelInputStream
```
protected ChannelInputStream()
```

ChannelInputStream

public ChannelInputStream(@WillCloseWhenClosed
                  SeekableByteChannel channel)

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

Class ChannelInputStream

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

channel

Constructor Detail

ChannelInputStream

ChannelInputStream

Method Detail

available

close

mark

markSupported

read

read

read

reset

skip