Apache Mina SSHD 2.15.0 · org.apache.sshd.common.util.io.input.LimitInputStream

Modifier and Type	Field and Description
private final AtomicBoolean	open
private long	remaining

Access	Constructor and Description
public	LimitInputStream(InputStream in, long length)

Method Summary

Modifier and Type	Method and Description
public int	available() Overrides java.io.FilterInputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.
public void	close() Overrides java.io.FilterInputStream.close. Implements java.nio.channels.Channel.close, java.io.Closeable.close. Closes this channel.
public boolean	isOpen() Implements java.nio.channels.Channel.isOpen. Tells whether or not this channel is open.
public int	read() Overrides java.io.FilterInputStream.read. Reads the next byte of data from the input stream.
public int	read(byte[] the buffer into which the data is read. b, int the start offset in array `b` at which the data is written. off, int the maximum number of bytes to read. len) Overrides java.io.FilterInputStream.read. Reads up to `len` bytes of data from this input stream into an array of bytes.
public long	skip(long the number of bytes to be skipped. n) Overrides java.io.FilterInputStream.skip. Skips over and discards `n` bytes of data from the input stream.

Inherited from java.io.FilterInputStream:: mark markSupported read reset

open	back to summary
private final AtomicBoolean open

remaining	back to summary
private long remaining

LimitInputStream	back to summary
public LimitInputStream(InputStream in, long length)

Method Detail

available	back to summary
public int available() throws IOException Overrides java.io.FilterInputStream.available. Doc from java.io.FilterInputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. Returns:int an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking. Annotations @Override Exceptions IOException: if an I/O error occurs.

available

back to summary

public int available() throws IOException

Overrides java.io.FilterInputStream.available.

Doc from java.io.FilterInputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Returns:int

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.FilterInputStream.close. Implements java.nio.channels.Channel.close, java.io.Closeable.close. Doc from java.nio.channels.Channel.close. Closes this channel. After a channel is closed, any further attempt to invoke I/O operations upon it will cause a `ClosedChannelException` to be thrown. If this channel is already closed then invoking this method has no effect. This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect. Annotations @Override Exceptions IOException: If an I/O error occurs

public void close() throws IOException

Overrides java.io.FilterInputStream.close.

Implements java.nio.channels.Channel.close, java.io.Closeable.close.

Doc from java.nio.channels.Channel.close.

Closes this channel.

After a channel is closed, any further attempt to invoke I/O operations upon it will cause a ClosedChannelException to be thrown.

If this channel is already closed then invoking this method has no effect.

This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

isOpen back to summary

isOpen	back to summary
public boolean isOpen() Implements java.nio.channels.Channel.isOpen. Doc from java.nio.channels.Channel.isOpen. Tells whether or not this channel is open. Returns:boolean `true` if, and only if, this channel is open Annotations @Override

public boolean isOpen()

Implements java.nio.channels.Channel.isOpen.

Doc from java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

Returns:boolean

true if, and only if, this channel is open

Annotations

@Override

read back to summary

read	back to summary
public int read() throws IOException Overrides java.io.FilterInputStream.read. Doc from java.io.FilterInputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Overrides java.io.FilterInputStream.read.

Doc from java.io.FilterInputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] b, int off, int len) throws IOException Overrides java.io.FilterInputStream.read. Doc from java.io.FilterInputStream.read. Reads up to `len` bytes of data from this input stream into an array of bytes. If `len` is not zero, the method blocks until some input is available; otherwise, no bytes are read and `0` is returned. Parameters b:byte[] the buffer into which the data is read. off:int the start offset in array `b` at which the data is written. len:int the maximum number of bytes to read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read(byte[] b, int off, int len) throws IOException

Overrides java.io.FilterInputStream.read.

Doc from java.io.FilterInputStream.read.

Reads up to len bytes of data from this input stream into an array of bytes. If len is not zero, the method blocks until some input is available; otherwise, no bytes are read and 0 is returned.

Parameters

b:byte[]: the buffer into which the data is read.
off:int: the start offset in array b at which the data is written.
len:int: the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

skip back to summary

skip	back to summary
public long skip(long n) throws IOException Overrides java.io.FilterInputStream.skip. Doc from java.io.FilterInputStream.skip. Skips over and discards `n` bytes of data from the input stream. The `skip` method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly `0`. The actual number of bytes skipped is returned. Parameters n:long the number of bytes to be skipped. Returns:long the actual number of bytes skipped. Annotations @Override Exceptions IOException: if `in.skip(n)` throws an IOException.

public long skip(long n) throws IOException

Overrides java.io.FilterInputStream.skip.

Doc from java.io.FilterInputStream.skip.

Skips over and discards n bytes of data from the input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. The actual number of bytes skipped is returned.

Parameters

n:long: the number of bytes to be skipped.

Returns:long

the actual number of bytes skipped.

Annotations

@Override

Exceptions

IOException:: if in.skip(n) throws an IOException.

public Class LimitInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail