Package com.parctechnologies.eclipse

Class FromEclipseQueue

java.lang.Object

java.io.InputStream

com.parctechnologies.eclipse.FromEclipseQueue

All Implemented Interfaces:

Closeable, AutoCloseable

public class FromEclipseQueue
extends InputStream

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

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

There is no public constructor; to access an FromEclipseQueue use the createFromEclipseQueue() of an object implementing the EclipseConnection interface or the getEclipseStderr() or getEclipseStdout() method of an object implementing the EclipseEngine interface.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()	Closes the queue (both eclipse and Java sides), removing any listener.
int	read()
int	read(byte[] b, int off, int len)	Read bytes from the FromEclipseQueue into a byte array.
void	removeListener()	Detach any QueueListener from this FromEclipseQueue.
void	setListener(QueueListener l)	Attach a QueueListener to this FromEclipseQueue for handling incoming data.

Methods inherited from class java.io.InputStream

mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Method Details

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

read

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

Read bytes from the FromEclipseQueue into a byte array. len bytes are read from the queue and stored in byte array b at offset off.

Overrides:

read in class InputStream

Returns:

the number of bytes read.

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

setListener

public void setListener(QueueListener l)
                 throws IOException

Attach a QueueListener to this FromEclipseQueue for handling incoming data. When ECLiPSe flushes the queue, the dataAvailable() method of the QueueListener is invoked.

Throws:

IOException

removeListener

public void removeListener()
                    throws IOException

Detach any QueueListener from this FromEclipseQueue.

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 InputStream

Throws:

IOException