org.jboss.aesh.terminal

Class TerminalString

java.lang.Object

org.jboss.aesh.terminal.TerminalString

All Implemented Interfaces:

java.lang.Comparable<TerminalString>

public class TerminalString
extends java.lang.Object
implements java.lang.Comparable<TerminalString>

Value object that describe how a string should be displayed

Field Summary

Fields

Modifier and Type	Field and Description
private int	ansiLength
private java.lang.String	characters
private TerminalColor	color
private boolean	ignoreRendering
private TerminalTextStyle	style

Constructor Summary

Constructors

Constructor and Description
TerminalString(java.lang.String chars)
TerminalString(java.lang.String chars, boolean ignoreRendering)
TerminalString(java.lang.String chars, TerminalColor color)
TerminalString(java.lang.String chars, TerminalColor color, TerminalTextStyle style)
TerminalString(java.lang.String chars, TerminalTextStyle style)

Method Summary

Modifier and Type	Method and Description
TerminalString	cloneRenderingAttributes(java.lang.String chars)
int	compareTo(TerminalString terminalString)
boolean	containSpaces()
boolean	equals(java.lang.Object o)
boolean	equalsIgnoreCharacter(TerminalString that)
int	getANSILength()
java.lang.String	getCharacters()
TerminalTextStyle	getStyle()
int	hashCode()
void	setCharacters(java.lang.String chars)
void	switchSpacesToEscapedSpaces()
java.lang.String	toString()
java.lang.String	toString(TerminalString prev) style, text color, background color
void	write(java.io.PrintStream out)

Methods inherited from class java.lang.Object

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

Field Detail

characters

private java.lang.String characters

style

private TerminalTextStyle style

color

private TerminalColor color

ignoreRendering

private boolean ignoreRendering

ansiLength

private int ansiLength

Constructor Detail

TerminalString

public TerminalString(java.lang.String chars,
                      TerminalColor color,
                      TerminalTextStyle style)

TerminalString

public TerminalString(java.lang.String chars,
                      TerminalColor color)

TerminalString

public TerminalString(java.lang.String chars,
                      TerminalTextStyle style)

TerminalString

public TerminalString(java.lang.String chars)

TerminalString

public TerminalString(java.lang.String chars,
                      boolean ignoreRendering)

Method Detail

getCharacters

public java.lang.String getCharacters()

setCharacters

public void setCharacters(java.lang.String chars)

containSpaces

public boolean containSpaces()

switchSpacesToEscapedSpaces

public void switchSpacesToEscapedSpaces()

getStyle

public TerminalTextStyle getStyle()

getANSILength

public int getANSILength()

cloneRenderingAttributes

public TerminalString cloneRenderingAttributes(java.lang.String chars)

toString

public java.lang.String toString(TerminalString prev)

style, text color, background color

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

write

public void write(java.io.PrintStream out)

equalsIgnoreCharacter

public boolean equalsIgnoreCharacter(TerminalString that)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(TerminalString terminalString)

Specified by:

compareTo in interface java.lang.Comparable<TerminalString>