cli

Class OutputDevice.Java

java.lang.Object

cli.NativeObject

cli.OutputDevice.Common

cli.OutputDevice.Java

All Implemented Interfaces:

OutputDevice.Interface

Direct Known Subclasses:

IODevice.Java

Enclosing class:

OutputDevice

public abstract static class OutputDevice.Java
extends OutputDevice.Common
implements OutputDevice.Interface

Java-implemented output devices.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Java(long I64_NativeRef) Constructor for IODevice.Java classes only.
protected	Java(java.lang.String J_DbgName) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract void	beep() Makes the output device beep.
abstract void	cleanScreen() Cleans the screen.
abstract boolean	closeDevice() Device closure handler.
abstract OutputDevice.ScreenInfo	getScreenInfo() Screen info accessor.
abstract boolean	openDevice() Device opening handler.
abstract OutputDevice.Interface	put(java.lang.String J_Text) Pushes characters to the output device.
boolean	wouldOutput(OutputDevice.Interface CLI_Device) Stack overflow protection.

Methods inherited from class cli.OutputDevice.Common

endl, printStackTrace, put, put, put

Methods inherited from class cli.NativeObject

createdFromNative, dontFinalize, finalize, forget, getbDoFinalize, getNativeRef, getObject, remember

Methods inherited from class java.lang.Object

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

Methods inherited from interface cli.OutputDevice.Interface

endl, getNativeRef, printStackTrace, put, put, put

Constructor Detail

Java

protected Java(java.lang.String J_DbgName)

Constructor.

Parameters:

J_DbgName - Debug name. Useful for traces only.

Java

protected Java(long I64_NativeRef)

Constructor for IODevice.Java classes only.

Parameters:

I64_NativeRef - Native instance reference.

Method Detail

openDevice

public abstract boolean openDevice()

Description copied from interface: OutputDevice.Interface

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

Specified by:

openDevice in interface OutputDevice.Interface

Returns:

true for success, false otherwise.

closeDevice

public abstract boolean closeDevice()

Description copied from interface: OutputDevice.Interface

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

Specified by:

closeDevice in interface OutputDevice.Interface

Returns:

true for success, false otherwise.

put

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

Description copied from interface: OutputDevice.Interface

Pushes characters to the output device.

Specified by:

put in interface OutputDevice.Interface

Parameters:

J_Text - String to be displayed by the device.

Returns:

The output device itself.

beep

public abstract void beep()

Description copied from interface: OutputDevice.Interface

Makes the output device beep.

Specified by:

beep in interface OutputDevice.Interface

cleanScreen

public abstract void cleanScreen()

Description copied from interface: OutputDevice.Interface

Cleans the screen.

Specified by:

cleanScreen in interface OutputDevice.Interface

getScreenInfo

public abstract OutputDevice.ScreenInfo getScreenInfo()

Description copied from interface: OutputDevice.Interface

Screen info accessor.

Specified by:

getScreenInfo in interface OutputDevice.Interface

Returns:

Screen info with possible ScreenInfo::UNKNOWN values.

wouldOutput

public boolean wouldOutput(OutputDevice.Interface CLI_Device)

Description copied from interface: OutputDevice.Interface

Stack overflow protection.

Specified by:

wouldOutput in interface OutputDevice.Interface

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.