Package org.aesh.terminal.formatting

Class TerminalString

java.lang.Object

org.aesh.terminal.formatting.TerminalString

All Implemented Interfaces:

Comparable<TerminalString>

public class TerminalString
extends Object
implements Comparable<TerminalString>

Value object that describe how a string should be displayed

Author:

Ståle W. Pedersen

Constructor Summary

Constructors

Constructor	Description
TerminalString(String chars)	Create a terminal string with default formatting.
TerminalString(String chars, boolean ignoreRendering)	Create a terminal string with optional rendering.
TerminalString(String chars, TerminalColor color)	Create a terminal string with the specified color.
TerminalString(String chars, TerminalColor color, TerminalTextStyle style)	Create a terminal string with the specified color and style.
TerminalString(String chars, TerminalTextStyle style)	Create a terminal string with the specified style.

Method Summary

Modifier and Type	Method	Description
TerminalString	cloneRenderingAttributes(String chars)	Create a new terminal string with the same rendering attributes.
int	compareTo(TerminalString terminalString)
boolean	containSpaces()	Check if the string contains spaces.
boolean	equals(Object o)
boolean	equalsIgnoreCharacter(TerminalString that)	Check if this terminal string has the same style and color as another, ignoring the actual character content.
int	getANSILength()	Get the length of ANSI escape sequences.
String	getCharacters()	Get the character content.
TerminalTextStyle	getStyle()	Get the text style.
int	hashCode()
boolean	isFormatted()	Check if this string has any formatting applied.
void	setCharacters(String chars)	Set the character content.
void	switchSpacesToEscapedSpaces()	Replace spaces with escaped spaces in the character content.
String	toString()
String	toString(TerminalString prev)	Get the string representation relative to a previous terminal string.
void	write(PrintStream out)	Write this terminal string to a print stream.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

TerminalString

public TerminalString(String chars,
 TerminalColor color,
 TerminalTextStyle style)

Create a terminal string with the specified color and style.

Parameters:

chars - the character content

color - the terminal color

style - the text style

TerminalString

public TerminalString(String chars,
 TerminalColor color)

Create a terminal string with the specified color.

Parameters:

chars - the character content

color - the terminal color

TerminalString

public TerminalString(String chars,
 TerminalTextStyle style)

Create a terminal string with the specified style.

Parameters:

chars - the character content

style - the text style

TerminalString

public TerminalString(String chars)

Create a terminal string with default formatting.

Parameters:

chars - the character content

TerminalString

public TerminalString(String chars,
 boolean ignoreRendering)

Create a terminal string with optional rendering.

Parameters:

chars - the character content

ignoreRendering - if true, no ANSI codes will be applied

Method Details

getCharacters

public String getCharacters()

Get the character content.

Returns:

the characters

setCharacters

public void setCharacters(String chars)

Set the character content.

Parameters:

chars - the new characters

containSpaces

public boolean containSpaces()

Check if the string contains spaces.

Returns:

true if spaces are present

switchSpacesToEscapedSpaces

public void switchSpacesToEscapedSpaces()

Replace spaces with escaped spaces in the character content.

getStyle

public TerminalTextStyle getStyle()

Get the text style.

Returns:

the text style

getANSILength

public int getANSILength()

Get the length of ANSI escape sequences.

Returns:

the ANSI code length, or 0 if rendering is ignored

cloneRenderingAttributes

public TerminalString cloneRenderingAttributes(String chars)

Create a new terminal string with the same rendering attributes.

Parameters:

chars - the new character content

Returns:

a new terminal string with the same style and color

isFormatted

public boolean isFormatted()

Check if this string has any formatting applied.

Returns:

true if color or style formatting is applied

toString

public String toString(TerminalString prev)

Get the string representation relative to a previous terminal string. Only outputs ANSI codes for attributes that differ.

Parameters:

prev - the previous terminal string

Returns:

the formatted string with ANSI codes

toString

public String toString()

Overrides:

toString in class Object

write

public void write(PrintStream out)

Write this terminal string to a print stream.

Parameters:

out - the output stream to write to

equalsIgnoreCharacter

public boolean equalsIgnoreCharacter(TerminalString that)

Check if this terminal string has the same style and color as another, ignoring the actual character content.

Parameters:

that - the terminal string to compare with

Returns:

true if style and color are equal

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(TerminalString terminalString)

Specified by:

compareTo in interface Comparable<TerminalString>