to top
Android APIs
Summary: Methods | [Expand All]
Since: API Level 1
public interface

EofSensorWatcher

org.apache.http.conn.EofSensorWatcher
Known Indirect Subclasses

Class Overview

A watcher for EofSensorInputStream. Each stream will notify it's watcher at most once.

Summary

Public Methods
abstract boolean eofDetected(InputStream wrapped)
Indicates that EOF is detected.
abstract boolean streamAbort(InputStream wrapped)
Indicates that the stream is aborted.
abstract boolean streamClosed(InputStream wrapped)
Indicates that the stream is closed.

Public Methods

public abstract boolean eofDetected (InputStream wrapped)

Since: API Level 1

Indicates that EOF is detected.

Parameters
wrapped the underlying stream which has reached EOF
Returns
  • true if wrapped should be closed, false if it should be left alone
Throws
IOException in case of an IO problem, for example if the watcher itself closes the underlying stream. The caller will leave the wrapped stream alone, as if false was returned.

public abstract boolean streamAbort (InputStream wrapped)

Since: API Level 1

Indicates that the stream is aborted. This method will be called only if EOF was not detected before aborting. Otherwise, eofDetected is called.

This method will also be invoked when an input operation causes an IOException to be thrown to make sure the input stream gets shut down.

Parameters
wrapped the underlying stream which has not reached EOF
Returns
  • true if wrapped should be closed, false if it should be left alone
Throws
IOException in case of an IO problem, for example if the watcher itself closes the underlying stream. The caller will leave the wrapped stream alone, as if false was returned.

public abstract boolean streamClosed (InputStream wrapped)

Since: API Level 1

Indicates that the stream is closed. This method will be called only if EOF was not detected before closing. Otherwise, eofDetected is called.

Parameters
wrapped the underlying stream which has not reached EOF
Returns
  • true if wrapped should be closed, false if it should be left alone
Throws
IOException in case of an IO problem, for example if the watcher itself closes the underlying stream. The caller will leave the wrapped stream alone, as if false was returned.