com.oracle.deviceaccess.generic

Interface GenericStreamIODevice

All Superinterfaces:

GenericDevice, Peripheral

public interface GenericStreamIODevice
extends GenericDevice

The GenericStreamIODevice interface defines generic methods for accessing and controlling peripheral devices capable of working with input and output streams.

A platform implementer may allow through this interface access and control of peripheral devices for which there exist no other more specific API such as SPIDevice or I2CDevice.

Field Summary

Fields inherited from interface com.oracle.deviceaccess.Peripheral

BIG_ENDIAN, LITTLE_ENDIAN, MIXED_ENDIAN, UNDEFINED_ID

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes and releases the underlying peripheral device, making it available to other applications.
java.io.InputStream	getInputStream() Returns an input stream to this device.
java.io.OutputStream	getOutputStream() Returns an output stream to this device.

Methods inherited from interface com.oracle.deviceaccess.generic.GenericDevice

getControl, setControl, setEventListener

Methods inherited from interface com.oracle.deviceaccess.Peripheral

getID, getName, getProperties, isOpen

Method Detail

getInputStream

java.io.InputStream getInputStream()
                                   throws java.io.IOException,
                                          PeripheralNotAvailableException

Returns an input stream to this device. The same InputStream instance is returned upon subsequent calls.
Note that if this device's input stream has been previously closed this method returns that same closed input stream without attempting to re-open it.

Note that the availability of new input data may be notified through an GenericEvent with ID GenericEvent.INPUT_DATA_AVAILABLE.

Returns:

the input stream.

Throws:

java.io.IOException - if an IO error occurred such as the device is not readable.

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).

getOutputStream

java.io.OutputStream getOutputStream()
                                     throws java.io.IOException,
                                            PeripheralNotAvailableException

Returns an output stream to this device. The same OutputStream instance is returned upon subsequent calls.
Note that if this device's output stream has been previously closed this method returns that same closed output stream without attempting to re-open it.

Note that an empty output buffer condition may be notified through an GenericEvent with ID GenericEvent.OUTPUT_BUFFER_EMPTY.

Returns:

the output stream.

Throws:

java.io.IOException - if an IO error occurred such as the device is not writable.

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).

close

void close()
           throws java.io.IOException

Closes and releases the underlying peripheral device, making it available to other applications. Once released, subsequent operations on that very same Peripheral instance will result in a PeripheralNotAvailableException being thrown.

This method has no effects if the peripheral device has already been closed.

Closing a GenericStreamIODevice will also close the device's InputStream and OutputStream.

Specified by:

close in interface Peripheral

Throws:

java.io.IOException - if an I/O error occurs.