EofSensorWatcher Interface Reference

A watcher for EofSensorInputStream . More...

Inheritance diagram for EofSensorWatcher:

Description

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

Author

Roland Weber

Version

Revision

552264

Since

4.0

Notice

The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.

/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Public Member Functions
boolean	eofDetected (InputStream wrapped) throws IOException
	Indicates that EOF is detected. More...
boolean	streamClosed (InputStream wrapped) throws IOException
	Indicates that the stream is closed. More...
boolean	streamAbort (InputStream wrapped) throws IOException
	Indicates that the stream is aborted. More...

Member Function Documentation

eofDetected()

boolean eofDetected

(

InputStream

wrapped

)

throws IOException

Parameters

wrapped

the underlying stream which has reached EOF

Returns

true if wrapped should be closed, false if it should be left alone

Exceptions

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.

Implemented in BasicManagedEntity, and BasicEofSensorWatcher.

streamClosed()

boolean streamClosed

(

InputStream

wrapped

)

throws IOException

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

Exceptions

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.

Implemented in BasicManagedEntity, and BasicEofSensorWatcher.

streamAbort()

boolean streamAbort

(

InputStream

wrapped

)

throws IOException

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

Exceptions

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.

Implemented in BasicManagedEntity, and BasicEofSensorWatcher.