org.harctoolbox.harchardware

Class BufferedExecutor

java.lang.Object

org.harctoolbox.harchardware.BufferedExecutor

All Implemented Interfaces:

Closeable, AutoCloseable, ICommandLineDevice, IHarcHardware

public class BufferedExecutor
extends Object
implements ICommandLineDevice

This class wraps an ICommandExecutor into a ICommandLineDevice.

Constructor Summary

Constructors

Constructor and Description
BufferedExecutor(ICommandExecutor executor)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flushInput()
String	getVersion() Returns the hardware version (not the version of the driver software).
boolean	isValid() Tries to identify instances that are not valid.
void	open() Opens the device with previously set parameters.
String	readString() Reads a line of text.
String	readString(boolean wait) Reads a line of text.
boolean	ready() Tells whether this stream is ready to be read.
void	sendString(String cmd) Sends a command (a String) to the instance.
void	setDebug(int debug) Sets a debug parameter.
void	setTimeout(int timeout) Set timeout in milliseconds.
void	setVerbose(boolean verbose) Sets a verbosity flag, causing commands to be executed verbosely.

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedExecutor

public BufferedExecutor(ICommandExecutor executor)

Method Detail

sendString

public void sendString(String cmd)
                throws IOException,
                       HarcHardwareException

Description copied from interface: ICommandLineDevice

Sends a command (a String) to the instance.

Specified by:

sendString in interface ICommandLineDevice

Parameters:

cmd - Command string to be sent.

Throws:

IOException

HarcHardwareException

readString

public String readString()
                  throws IOException

Description copied from interface: ICommandLineDevice

Reads a line of text. A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a linefeed.

Specified by:

readString in interface ICommandLineDevice

Returns:

A String containing the contents of the line, not including any line-termination characters, or null if no input available.

Throws:

IOException

readString

public String readString(boolean wait)
                  throws IOException

Description copied from interface: ICommandLineDevice

Reads a line of text. A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a linefeed.

Specified by:

readString in interface ICommandLineDevice

Parameters:

wait - if true, wait until something arrives, otherwise return null if nothing there.

Returns:

A String containing the contents of the line, not including any line-termination characters, or null if no input available.

Throws:

IOException

ready

public boolean ready()
              throws IOException

Description copied from interface: ICommandLineDevice

Tells whether this stream is ready to be read. A buffered character stream is ready if the buffer is not empty, or if the underlying character stream is ready.

Specified by:

ready in interface ICommandLineDevice

Returns:

True if the next read() is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block.

Throws:

IOException - If an I/O error occurs

flushInput

public void flushInput()
                throws IOException

Specified by:

flushInput in interface ICommandLineDevice

Throws:

IOException

getVersion

public String getVersion()
                  throws IOException

Description copied from interface: IHarcHardware

Returns the hardware version (not the version of the driver software). May be null if no relevant information available.

Specified by:

getVersion in interface IHarcHardware

Returns:

Version string. Semantics can vary.

Throws:

IOException

setVerbose

public void setVerbose(boolean verbose)

Description copied from interface: IHarcHardware

Sets a verbosity flag, causing commands to be executed verbosely. Exact semantic depends on the implementation. Typically, all communication with the device is echoed to stderr.

Specified by:

setVerbose in interface IHarcHardware

Parameters:

verbose - on or off

setDebug

public void setDebug(int debug)

Description copied from interface: IHarcHardware

Sets a debug parameter. Exact semantic depends on the implementation.

Specified by:

setDebug in interface IHarcHardware

setTimeout

public void setTimeout(int timeout)
                throws IOException

Description copied from interface: IHarcHardware

Set timeout in milliseconds. Exact semantics may be dependent on the hardware.

Specified by:

setTimeout in interface IHarcHardware

Parameters:

timeout - Timeout in milliseconds.

Throws:

IOException

isValid

public boolean isValid()

Description copied from interface: IHarcHardware

Tries to identify instances that are not valid. Exact meaning can vary.

Specified by:

isValid in interface IHarcHardware

Returns:

validity of the instance.

open

public void open()
          throws HarcHardwareException,
                 IOException

Description copied from interface: IHarcHardware

Opens the device with previously set parameters.

Specified by:

open in interface IHarcHardware

Throws:

HarcHardwareException

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException