org.stekikun.dolmen.common

Class Prompt.TermStream

java.lang.Object

org.stekikun.dolmen.common.Prompt.TermStream

Enclosing class:

Prompt

public static final class Prompt.TermStream
extends Object

A wrapper around a PrintStream which may or may not support colored output via ANSI terminal control sequences.

Author:

Stéphane Lescuyer

Constructor Summary

Constructors

Constructor and Description
TermStream(PrintStream out, boolean colorSupport) Returns a wrapper around the given print stream out with support for ANSI control sequences if colorSupport is true.

Method Summary

Modifier and Type	Method and Description
Prompt.TermStream	bg(Prompt.Colors c) Sets the background text color to c.
Prompt.TermStream	blink() Enables the 'blink' text style.
Prompt.TermStream	bold() Enables the 'bold' text style.
Prompt.TermStream	clear() Reset the current text attributes to default.
Prompt.TermStream	dim() Enables the 'dim' text style.
Prompt.TermStream	fg(Prompt.Colors c) Sets the foreground text color to c.
Prompt.TermStream	newline() Prints a system line separator.
Prompt.TermStream	print(char c) Prints the given character to the stream.
Prompt.TermStream	print(String s) Prints the given string to the stream.
Prompt.TermStream	println(String s) Prints the given string followed by a system line separator.
Prompt.TermStream	reverse() Enables the 'reverse' text style.
Prompt.TermStream	spaces(int nspaces) Prints the given number of spaces (' ').
Prompt.TermStream	underlined() Enables the 'underlined' text style.

Methods inherited from class java.lang.Object

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

Constructor Detail

TermStream

public TermStream(PrintStream out,
                  boolean colorSupport)

Returns a wrapper around the given print stream out with support for ANSI control sequences if colorSupport is true. If instead, colorSupport is false, methods such as clear(), dim() or Prompt.fg(Colors) will simply do nothing.

Parameters:

out -

colorSupport -

Method Detail

print

public Prompt.TermStream print(char c)

Prints the given character to the stream.

Parameters:

c -

Returns:

this stream

print

public Prompt.TermStream print(String s)

Prints the given string to the stream.

Parameters:

s -

Returns:

this stream

println

public Prompt.TermStream println(String s)

Prints the given string followed by a system line separator.

Parameters:

s -

Returns:

this stream

newline

public Prompt.TermStream newline()

Prints a system line separator.

Returns:

this stream

spaces

public Prompt.TermStream spaces(int nspaces)

Prints the given number of spaces (' ').

Parameters:

nspaces -

Returns:

this stream

clear

public Prompt.TermStream clear()

Reset the current text attributes to default.

Returns:

this stream

bold

public Prompt.TermStream bold()

Enables the 'bold' text style.

Returns:

this stream

dim

public Prompt.TermStream dim()

Enables the 'dim' text style.

Returns:

this stream

underlined

public Prompt.TermStream underlined()

Enables the 'underlined' text style.

Returns:

this stream

blink

public Prompt.TermStream blink()

Enables the 'blink' text style.

Returns:

this stream

reverse

public Prompt.TermStream reverse()

Enables the 'reverse' text style.

Returns:

this stream

fg

public Prompt.TermStream fg(Prompt.Colors c)

Sets the foreground text color to c.

Parameters:

c -

Returns:

this stream

bg

public Prompt.TermStream bg(Prompt.Colors c)

Sets the background text color to c.

Parameters:

c -

Returns:

this stream