Apache HttpComponents Core HTTP/1.1 5.2.4 · org.apache.hc.core5.http.io.EofSensorInputStream

Modifier and Type	Field and Description
private final EofSensorWatcher	eofWatcher The watcher to be notified, if any.
private boolean	selfClosed Indicates whether this stream itself is closed.
private InputStream	wrappedStream The wrapped input stream, while accessible.

Access	Constructor and Description
public	EofSensorInputStream(final InputStream the wrapped stream in, final EofSensorWatcher the watcher for events, or `null` for auto-close behavior without notification watcher) Creates a new EOF sensor.

Method Summary

Modifier and Type	Method and Description
public void	abort() Aborts this stream.
public int	available() Overrides java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected.
private void	checkAbort() Detects stream abort and notifies the watcher.
private void	checkClose() Detects stream close and notifies the watcher.
private void	checkEOF(final int the result of the calling read operation. A negative value indicates that EOF is reached. eof) Detects EOF and notifies the watcher.
public void	close() Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.
pack-priv InputStream	getWrappedStream()
private boolean	Returns: `true` if the underlying stream is accessible, `false` if this stream is in EOF mode and detached from the underlying stream isReadAllowed() Checks whether the underlying stream can be read from.
pack-priv boolean	isSelfClosed()
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(final byte[] the buffer into which the data is read. b, final int the start offset in array `b` at which the data is written. off, final int the maximum number of bytes to read. len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.
public int	read(final byte[] the buffer into which the data is read. b) Overrides java.io.InputStream.read. Reads some number of bytes from the input stream and stores them into the buffer array `b`.

Inherited from java.io.InputStream:: mark markSupported nullInputStream readAllBytes readNBytes readNBytes reset skip skipNBytes transferTo

eofWatcher	back to summary
private final EofSensorWatcher eofWatcher The watcher to be notified, if any.

selfClosed	back to summary
private boolean selfClosed Indicates whether this stream itself is closed. If it isn't, but `wrappedStream` is `null`, we're running in EOF mode. All read operations will indicate EOF without accessing the underlying stream. After closing this stream, read operations will trigger an `IOException`. See Also `isReadAllowed`

wrappedStream	back to summary
private InputStream wrappedStream The wrapped input stream, while accessible. The value changes to `null` when the wrapped stream becomes inaccessible.

EofSensorInputStream	back to summary
public EofSensorInputStream(final InputStream in, final EofSensorWatcher watcher) Creates a new EOF sensor. If no watcher is passed, the underlying stream will simply be closed when EOF is detected or `close` is called. Otherwise, the watcher decides whether the underlying stream should be closed before detaching from it. Parameters in:InputStream the wrapped stream watcher:EofSensorWatcher the watcher for events, or `null` for auto-close behavior without notification

Method Detail

abort back to summary

abort	back to summary
public void abort() throws IOException Aborts this stream. This is a special version of `close()` which prevents re-use of the underlying connection, if any. Calling this method indicates that there should be no attempt to read until the end of the stream. Exceptions IOException: in case of an IO problem on closing the underlying stream

public void abort() throws IOException

Aborts this stream. This is a special version of close() which prevents re-use of the underlying connection, if any. Calling this method indicates that there should be no attempt to read until the end of the stream.

Exceptions

IOException:: in case of an IO problem on closing the underlying stream

available back to summary

available	back to summary
public int available() throws IOException Overrides java.io.InputStream.available. Doc from java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on 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. Note that while some implementations of `InputStream` will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream. A subclass's implementation of this method may choose to throw an `IOException` if this input stream has been closed by invoking the `close()` method. Returns:int an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or `0` when it reaches the end of the input stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int available() throws IOException

Overrides java.io.InputStream.available.

Doc from java.io.InputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on 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.

Note that while some implementations of InputStream will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream.

A subclass's implementation of this method may choose to throw an IOException if this input stream has been closed by invoking the close() method.

Returns:int

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

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

checkAbort back to summary

checkAbort	back to summary
private void checkAbort() throws IOException Detects stream abort and notifies the watcher. There's not much to detect since this is called by `abort()`. The watcher will only be notified if this stream is aborted for the first time and before EOF has been detected or the stream has been `closed` gracefully. This stream will be detached from the underlying stream to prevent multiple notifications to the watcher. Exceptions IOException: in case of an IO problem on closing the underlying stream

private void checkAbort() throws IOException

Detects stream abort and notifies the watcher. There's not much to detect since this is called by abort(). The watcher will only be notified if this stream is aborted for the first time and before EOF has been detected or the stream has been closed gracefully. This stream will be detached from the underlying stream to prevent multiple notifications to the watcher.

Exceptions

IOException:: in case of an IO problem on closing the underlying stream

checkClose back to summary

checkClose	back to summary
private void checkClose() throws IOException Detects stream close and notifies the watcher. There's not much to detect since this is called by `close`. The watcher will only be notified if this stream is closed for the first time and before EOF has been detected. This stream will be detached from the underlying stream to prevent multiple notifications to the watcher. Exceptions IOException: in case of an IO problem on closing the underlying stream

private void checkClose() throws IOException

Detects stream close and notifies the watcher. There's not much to detect since this is called by close. The watcher will only be notified if this stream is closed for the first time and before EOF has been detected. This stream will be detached from the underlying stream to prevent multiple notifications to the watcher.

Exceptions

IOException:: in case of an IO problem on closing the underlying stream

checkEOF back to summary

checkEOF	back to summary
private void checkEOF(final int eof) throws IOException Detects EOF and notifies the watcher. This method should only be called while the underlying stream is still accessible. Use `isReadAllowed` to check that condition. If EOF is detected, the watcher will be notified and this stream is detached from the underlying stream. This prevents multiple notifications from this stream. Parameters eof:int the result of the calling read operation. A negative value indicates that EOF is reached. Exceptions IOException: in case of an IO problem on closing the underlying stream

private void checkEOF(final int eof) throws IOException

Detects EOF and notifies the watcher. This method should only be called while the underlying stream is still accessible. Use isReadAllowed to check that condition.

If EOF is detected, the watcher will be notified and this stream is detached from the underlying stream. This prevents multiple notifications from this stream.

Parameters

eof:int: the result of the calling read operation. A negative value indicates that EOF is reached.

Exceptions

IOException:: in case of an IO problem on closing the underlying stream

close	back to summary
public void close() throws IOException Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Doc from java.io.InputStream.close. Closes this input stream and releases any system resources associated with the stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.InputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

getWrappedStream	back to summary
pack-priv InputStream getWrappedStream()

isReadAllowed back to summary

isReadAllowed	back to summary
private boolean isReadAllowed() throws IOException Checks whether the underlying stream can be read from. Returns:boolean `true` if the underlying stream is accessible, `false` if this stream is in EOF mode and detached from the underlying stream Exceptions IOException: if this stream is already closed

private boolean isReadAllowed() throws IOException

Checks whether the underlying stream can be read from.

Returns:boolean

true if the underlying stream is accessible, false if this stream is in EOF mode and detached from the underlying stream

Exceptions

IOException:: if this stream is already closed

isSelfClosed	back to summary
pack-priv boolean isSelfClosed()

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.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

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.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(final byte[] b, final int off, final int len) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes. An attempt is made to read as many as `len` bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If `len` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[off]`, the next one into `b[off+1]`, and so on. The number of bytes read is, at most, equal to `len`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[off]` through `b[off+`k`-1]`, leaving elements `b[off+`k`]` through `b[off+len-1]` unaffected. In every case, elements `b[0]` through `b[off-1]` and elements `b[off+len]` through `b[b.length-1]` are unaffected. 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 the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

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

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

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 the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

read back to summary

read	back to summary
public int read(final byte[] b) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads some number of bytes from the input stream and stores them into the buffer array `b`. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If the length of `b` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at the end of the file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[0]`, the next one into `b[1]`, and so on. The number of bytes read is, at most, equal to the length of `b`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[0]` through `b[`k`-1]`, leaving elements `b[`k`]` through `b[b.length-1]` unaffected. Parameters b:byte[] the buffer into which the data is 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 the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.

public int read(final byte[] b) throws IOException

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads some number of bytes from the input stream and stores them into the buffer array b. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown.

If the length of b is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at the end of the file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[0], the next one into b[1], and so on. The number of bytes read is, at most, equal to the length of b. Let k be the number of bytes actually read; these bytes will be stored in elements b[0] through b[k-1], leaving elements b[k] through b[b.length-1] unaffected.

Parameters

b:byte[]: the buffer into which the data is 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 the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.

public Class EofSensorInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail