de.mhus.lib.core.console

Class Console

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

java.io.PrintStream

de.mhus.lib.core.console.Console

All Implemented Interfaces:

IBase, Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

ANSIConsole, SimpleConsole, VirtualConsole

public abstract class Console
extends PrintStream
implements IBase

Abstract Console class.

Version:

$Id: $Id

Author:

mikehummel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Console.COLOR

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HEIGHT Constant DEFAULT_HEIGHT=25
static int	DEFAULT_WIDTH Constant DEFAULT_WIDTH=40
protected LinkedList<String>	history

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
Console() Constructor for Console.
Console(PrintStream out) Constructor for Console.
Console(PrintStream out, boolean flush, String charset) Constructor for Console.

Method Summary

Modifier and Type	Method and Description
abstract void	cleanup() cleanup.
void	cr() cr.
static Console	create() Factory to return the correct implementation of console.
ConsoleProgressBar	createProgressBar() createProgressBar.
abstract Console.COLOR	getBackgroundColor() getBackgroundColor.
abstract int	getCursorX() getCursorX.
abstract int	getCursorY() getCursorY.
abstract Console.COLOR	getForegroundColor() getForegroundColor.
abstract int	getHeight() getHeight.
abstract int	getWidth() getWidth.
abstract boolean	isBlink() isBlink.
abstract boolean	isBold() isBold.
abstract boolean	isSupportBlink() isSupportBlink.
abstract boolean	isSupportBold() isSupportBold.
abstract boolean	isSupportColor() isSupportColor.
abstract boolean	isSupportCursor() isSupportCursor.
abstract boolean	isSupportSize() isSupportSize.
void	printLine() printLine.
void	printLine(char c) printLine.
String	readLine() readLine.
abstract String	readLine(LinkedList<String> history) readLine.
char[]	readPassword() readPassword.
abstract void	setBlink(boolean blink) setBlink.
abstract void	setBold(boolean bold) setBold.
abstract void	setColor(Console.COLOR foreground, Console.COLOR background) setColor.
abstract void	setCursor(int x, int y) setCursor.

Methods inherited from class java.io.PrintStream

append, append, append, checkError, clearError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write

Methods inherited from class java.io.FilterOutputStream

write

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

Constant DEFAULT_WIDTH=40

See Also:

Constant Field Values

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT

Constant DEFAULT_HEIGHT=25

See Also:

Constant Field Values

history

protected LinkedList<String> history

Constructor Detail

Console

public Console()

Constructor for Console.

Console

public Console(PrintStream out)

Constructor for Console.

Parameters:

out - a PrintStream object.

Console

public Console(PrintStream out,
               boolean flush,
               String charset)
        throws UnsupportedEncodingException

Constructor for Console.

Parameters:

out - a PrintStream object.

flush - a boolean.

charset - a String object.

Throws:

UnsupportedEncodingException - if any.

Method Detail

create

public static Console create()

Factory to return the correct implementation of console.

Returns:

a Console object.

readLine

public String readLine()

readLine.

Returns:

a String object.

readLine

public abstract String readLine(LinkedList<String> history)

readLine.

Parameters:

history - a LinkedList object.

Returns:

a String object.

readPassword

public char[] readPassword()

readPassword.

Returns:

an array of char.

cr

public void cr()

cr.

isSupportSize

public abstract boolean isSupportSize()

isSupportSize.

Returns:

a boolean.

getWidth

public abstract int getWidth()

getWidth.

Returns:

a int.

getHeight

public abstract int getHeight()

getHeight.

Returns:

a int.

isSupportCursor

public abstract boolean isSupportCursor()

isSupportCursor.

Returns:

a boolean.

setCursor

public abstract void setCursor(int x,
                               int y)

setCursor.

Parameters:

x - a int.

y - a int.

getCursorX

public abstract int getCursorX()

getCursorX.

Returns:

a int.

getCursorY

public abstract int getCursorY()

getCursorY.

Returns:

a int.

createProgressBar

public ConsoleProgressBar createProgressBar()

createProgressBar.

Returns:

a ConsoleProgressBar object.

isSupportColor

public abstract boolean isSupportColor()

isSupportColor.

Returns:

a boolean.

setColor

public abstract void setColor(Console.COLOR foreground,
                              Console.COLOR background)

setColor.

Parameters:

foreground - a Console.COLOR object.

background - a Console.COLOR object.

getForegroundColor

public abstract Console.COLOR getForegroundColor()

getForegroundColor.

Returns:

a Console.COLOR object.

getBackgroundColor

public abstract Console.COLOR getBackgroundColor()

getBackgroundColor.

Returns:

a Console.COLOR object.

isSupportBlink

public abstract boolean isSupportBlink()

isSupportBlink.

Returns:

a boolean.

setBlink

public abstract void setBlink(boolean blink)

setBlink.

Parameters:

blink - a boolean.

isBlink

public abstract boolean isBlink()

isBlink.

Returns:

a boolean.

isSupportBold

public abstract boolean isSupportBold()

isSupportBold.

Returns:

a boolean.

setBold

public abstract void setBold(boolean bold)

setBold.

Parameters:

bold - a boolean.

isBold

public abstract boolean isBold()

isBold.

Returns:

a boolean.

cleanup

public abstract void cleanup()

cleanup.

printLine

public void printLine()

printLine.

printLine

public void printLine(char c)

printLine.

Parameters:

c - a char.