cli

Interface OutputDevice.Interface

All Known Subinterfaces:

IODevice.Interface, NonBlockingIODevice.Interface

All Known Implementing Classes:

Console, InputFileDevice, IODevice.Java, IODevice.Native, IOMux, NonBlockingIODevice.Java, NonBlockingIODevice.Native, OutputDevice.Java, OutputDevice.Native, OutputFileDevice, SingleCommand, StringDevice, TelnetConnection

Enclosing class:

OutputDevice

public static interface OutputDevice.Interface

Generic output device interface.

Method Summary

Modifier and Type	Method and Description
void	beep() Makes the output device beep.
void	cleanScreen() Cleans the screen.
boolean	closeDevice() Device closure handler.
OutputDevice.Interface	endl() Pushes an end of line to be displayed by the output device.
long	getNativeRef() Native object interface compliance.
OutputDevice.ScreenInfo	getScreenInfo() Screen info accessor.
boolean	openDevice() Device opening handler.
void	printStackTrace(java.lang.Exception J_Exception) Exception stack trace display.
OutputDevice.Interface	put(java.lang.Double J_Double) Pushes a double value to be displayed by the output device.
OutputDevice.Interface	put(java.lang.Float J_Float) Pushes a float value to be displayed by the output device.
OutputDevice.Interface	put(java.lang.Integer J_Integer) Pushes an integer value to be displayed by the output device.
OutputDevice.Interface	put(java.lang.String J_Text) Pushes characters to the output device.
boolean	wouldOutput(OutputDevice.Interface CLI_Device) Stack overflow protection.

Method Detail

openDevice

boolean openDevice()

Device opening handler. Should rather be protected, but this is not possible in a Java interface.

Returns:

true for success, false otherwise.

closeDevice

boolean closeDevice()

Device closure handler. Should rather be protected, but this is not possible in a Java interface.

Returns:

true for success, false otherwise.

put

OutputDevice.Interface put(java.lang.String J_Text)

Pushes characters to the output device.

Parameters:

J_Text - String to be displayed by the device.

Returns:

The output device itself.

put

OutputDevice.Interface put(java.lang.Integer J_Integer)

Pushes an integer value to be displayed by the output device.

Parameters:

J_Integer - Integer value to be displayed by the device.

Returns:

The output device itself.

put

OutputDevice.Interface put(java.lang.Float J_Float)

Pushes a float value to be displayed by the output device.

Parameters:

J_Float - Float value to be displayed by the device.

Returns:

The output device itself.

put

OutputDevice.Interface put(java.lang.Double J_Double)

Pushes a double value to be displayed by the output device.

Parameters:

J_Double - Double value to be displayed by the device.

Returns:

The output device itself.

endl

OutputDevice.Interface endl()

Pushes an end of line to be displayed by the output device.

Returns:

The output device itself.

beep

void beep()

Makes the output device beep.

cleanScreen

void cleanScreen()

Cleans the screen.

getScreenInfo

OutputDevice.ScreenInfo getScreenInfo()

Screen info accessor.

Returns:

Screen info with possible ScreenInfo::UNKNOWN values.

wouldOutput

boolean wouldOutput(OutputDevice.Interface CLI_Device)

Stack overflow protection.

Parameters:

CLI_Device - Other device that the callee device should check it would output characters to.

Returns:

true if the callee device would redirect characters to the given device for output. Determines whether the current device would output the given device in anyway. Default implementation checks whether this is the self device.

printStackTrace

void printStackTrace(java.lang.Exception J_Exception)

Exception stack trace display.

Parameters:

J_Exception - Exception which stack trace to display.

getNativeRef

long getNativeRef()

Native object interface compliance.

Returns:

The native reference of the instance.