Package com.parctechnologies.eclipse

Class ToEclipseQueue

java.lang.Object

java.io.OutputStream

com.parctechnologies.eclipse.ToEclipseQueue

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ToEclipseQueue
extends OutputStream

A queue for sending data from Java to ECLiPSe. This class performs no processing of the data and cannot for example, convert to EXDR format (see EXDROutputStream for a class which can do this).

In addition to the standard methods inherited from its superclass, this class also provides the ability to attach a QueueListener object to the ToEclipseQueue, as a handler for data requests from ECLiPSe.

There is no public constructor; to access an ToEclipseQueue use the createToEclipseQueue() of an object implementing the EclipseConnection interface or the getEclipseStdin() method of an object implementing the EclipseEngine interface.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the queue (both eclipse and Java sides), removing any listener.
void	flush()	Calls the superclass' flush method
void	removeListener()	Detach any QueueListener from this ToEclipseQueue.
void	setListener(QueueListener l)	Attach a QueueListener to this ToEclipseQueue for handling requests for data.
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.io.OutputStream

nullOutputStream, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException

setListener

public void setListener(QueueListener l)
                 throws IOException

Attach a QueueListener to this ToEclipseQueue for handling requests for data. When ECLiPSe tries to read from an empty queue with a QueueListener attached, the dataAvailable() method of the QueueListener is invoked.

Throws:

IOException

removeListener

public void removeListener()
                    throws IOException

Detach any QueueListener from this ToEclipseQueue.

Throws:

IOException

flush

public void flush()
           throws IOException

Calls the superclass' flush method

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Closes the queue (both eclipse and Java sides), removing any listener.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException