org.beryx.textio

Class TerminalProperties<T extends TextTerminal<T>>

java.lang.Object

org.beryx.textio.TerminalProperties<T>

Type Parameters:

T - the type of the TextTerminal.

public class TerminalProperties<T extends TextTerminal<T>>
extends java.lang.Object

A map of properties associated with a TextTerminal.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TerminalProperties.BooleanChangeListener<TT extends TextTerminal<TT>>
static interface	TerminalProperties.ChangeListener<TT extends TextTerminal<TT>,V>
static interface	TerminalProperties.DoubleChangeListener<TT extends TextTerminal<TT>>
static interface	TerminalProperties.ExtendedChangeListener<TT extends TextTerminal<TT>>
static interface	TerminalProperties.IntChangeListener<TT extends TextTerminal<TT>>
static interface	TerminalProperties.LongChangeListener<TT extends TextTerminal<TT>>
static interface	TerminalProperties.StringChangeListener<TT extends TextTerminal<TT>>

Constructor Summary

Constructors

Constructor and Description
TerminalProperties(T textTerminal)

Method Summary

Modifier and Type	Method and Description
void	addBooleanListener(java.lang.String key, boolean defaultValue, TerminalProperties.BooleanChangeListener<T> listener) Convenience method that adds a listener for the boolean property with the specified key.
void	addDoubleListener(java.lang.String key, double defaultValue, TerminalProperties.DoubleChangeListener<T> listener) Convenience method that adds a listener for the double property with the specified key.
void	addIntListener(java.lang.String key, int defaultValue, TerminalProperties.IntChangeListener<T> listener) Convenience method that adds a listener for the int property with the specified key.
void	addListener(TerminalProperties.ExtendedChangeListener<T> listener) Adds a listener for this TerminalProperties instance.
void	addLongListener(java.lang.String key, long defaultValue, TerminalProperties.LongChangeListener<T> listener) Convenience method that adds a listener for the long property with the specified key.
void	addStringListener(java.lang.String key, java.lang.String defaultValue, TerminalProperties.StringChangeListener<T> listener) Convenience method that adds a listener for the String property with the specified key.
java.util.Set<java.lang.String>	getAllKeys()
boolean	getBoolean(java.lang.String key, boolean defaultValue) Gets the boolean value of the property with the specified key.
double	getDouble(java.lang.String key, double defaultValue) Gets the double value of the property with the specified key.
int	getInt(java.lang.String key, int defaultValue) Gets the int value of the property with the specified key.
java.util.List<TerminalProperties.ExtendedChangeListener<T>>	getListeners()
long	getLong(java.lang.String key, long defaultValue) Gets the long value of the property with the specified key.
java.util.Set<java.lang.String>	getMatchingKeys(java.util.function.Predicate<java.lang.String> keyFilter)
java.util.Set<java.lang.String>	getMatchingKeys(java.lang.String regex)
java.lang.String	getString(java.lang.String key)
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue) Gets the String value of the property with the specified key.
java.lang.Object	put(java.lang.String key, java.lang.Object value) Sets the value associated with the specified key.
void	putAll(java.util.Map<java.lang.String,? extends java.lang.Object> map)
java.lang.Object	remove(java.lang.String key) Removes the property with the specified key.
boolean	removeListener(TerminalProperties.ExtendedChangeListener<T> listener) Removes the listener passed as argument.
void	setInputBackgroundColor(java.awt.Color bgcolor) Convenience method that associates the hex representation of the specified bgcolor with the key
void	setInputBackgroundColor(java.lang.String bgcolor) Convenience method that associates the specified bgcolor with the key
void	setInputBold(boolean bold) Convenience method that associates the boolean value bold with the key
void	setInputColor(java.awt.Color color) Convenience method that associates the hex representation of the specified color with the key
void	setInputColor(java.lang.String color) Convenience method that associates the specified color with the key
void	setInputItalic(boolean italic) Convenience method that associates the boolean value italic with the key
void	setInputUnderline(boolean underline) Convenience method that associates the boolean value underline with the key
void	setPaneBackgroundColor(java.awt.Color bgcolor) Convenience method that associates the hex representation of the specified bgcolor with the key
void	setPaneBackgroundColor(java.lang.String bgcolor) Convenience method that associates the specified bgcolor with the key
void	setPaneDimension(int width, int height) Convenience method that associates the specified width and height with the keys and
void	setPaneHeight(int height) Convenience method that associates the specified height with the key
void	setPaneWidth(int width) Convenience method that associates the specified width with the key
void	setPromptBackgroundColor(java.awt.Color bgcolor) Convenience method that associates the hex representation of the specified bgcolor with the key
void	setPromptBackgroundColor(java.lang.String bgcolor) Convenience method that associates the specified bgcolor with the key
void	setPromptBold(boolean bold) Convenience method that associates the boolean value bold with the key
void	setPromptColor(java.awt.Color color) Convenience method that associates the hex representation of the specified color with the key
void	setPromptColor(java.lang.String color) Convenience method that associates the specified color with the key
void	setPromptItalic(boolean italic) Convenience method that associates the boolean value italic with the key
void	setPromptUnderline(boolean underline) Convenience method that associates the boolean value underline with the key

Methods inherited from class java.lang.Object

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

Constructor Detail

TerminalProperties

public TerminalProperties(T textTerminal)

Method Detail

getListeners

public java.util.List<TerminalProperties.ExtendedChangeListener<T>> getListeners()

Returns:

the list of TerminalProperties.ExtendedChangeListener for this instance of TerminalProperties.

remove

public java.lang.Object remove(java.lang.String key)

Removes the property with the specified key.

Parameters:

key - the key whose associated value should be removed.

Returns:

the old value associated with the specified key.

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)

Sets the value associated with the specified key.

Parameters:

key - the key with which the specified value should be associated.

value - the value to be associated with the specified key.

Returns:

putAll

public void putAll(java.util.Map<java.lang.String,? extends java.lang.Object> map)

getAllKeys

public java.util.Set<java.lang.String> getAllKeys()

getMatchingKeys

public java.util.Set<java.lang.String> getMatchingKeys(java.lang.String regex)

getMatchingKeys

public java.util.Set<java.lang.String> getMatchingKeys(java.util.function.Predicate<java.lang.String> keyFilter)

getString

public java.lang.String getString(java.lang.String key)

Returns:

the value associated with the specified key.

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultValue)

Gets the String value of the property with the specified key.

Parameters:

key - the key whose associated value should be retrieved.

defaultValue - the value to be returned if no value is associated with the specified key or the associated value is null or empty.

Returns:

the string value of the property with the specified key.

getInt

public int getInt(java.lang.String key,
                  int defaultValue)

Gets the int value of the property with the specified key.

Parameters:

key - the key whose associated value should be retrieved.

defaultValue - the value to be returned if no value is associated with the specified key or the string representation of the value cannot be converted to int.

Returns:

the int value of the property with the specified key.

getLong

public long getLong(java.lang.String key,
                    long defaultValue)

Gets the long value of the property with the specified key.

Parameters:

key - the key whose associated value should be retrieved.

defaultValue - the value to be returned if no value is associated with the specified key or the string representation of the value cannot be converted to long.

Returns:

the long value of the property with the specified key.

getDouble

public double getDouble(java.lang.String key,
                        double defaultValue)

Gets the double value of the property with the specified key.

Parameters:

key - the key whose associated value should be retrieved.

defaultValue - the value to be returned if no value is associated with the specified key or the string representation of the value cannot be converted to double.

Returns:

the double value of the property with the specified key.

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean defaultValue)

Gets the boolean value of the property with the specified key.

Parameters:

key - the key whose associated value should be retrieved.

defaultValue - the value to be returned if no value is associated with the specified key.

Returns:

the boolean value of the property with the specified key.

addListener

public void addListener(TerminalProperties.ExtendedChangeListener<T> listener)

Adds a listener for this TerminalProperties instance.

Parameters:

listener - the listener to be added.

removeListener

public boolean removeListener(TerminalProperties.ExtendedChangeListener<T> listener)

Removes the listener passed as argument.

Parameters:

listener - the listener to be added.

Returns:

true, if the listener has been found and removed.

addStringListener

public void addStringListener(java.lang.String key,
                              java.lang.String defaultValue,
                              TerminalProperties.StringChangeListener<T> listener)

Convenience method that adds a listener for the String property with the specified key.

Parameters:

key - the key of the property for which the listener is added.

defaultValue - the value to be used if the new value is null.

listener - the listener to be added.

addIntListener

public void addIntListener(java.lang.String key,
                           int defaultValue,
                           TerminalProperties.IntChangeListener<T> listener)

Convenience method that adds a listener for the int property with the specified key.

Parameters:

key - the key of the property for which the listener is added.

defaultValue - the value to be used if the new value cannot be converted to an int.

listener - the listener to be added.

addLongListener

public void addLongListener(java.lang.String key,
                            long defaultValue,
                            TerminalProperties.LongChangeListener<T> listener)

Convenience method that adds a listener for the long property with the specified key.

Parameters:

key - the key of the property for which the listener is added.

defaultValue - the value to be used if the new value cannot be converted to a long.

listener - the listener to be added.

addDoubleListener

public void addDoubleListener(java.lang.String key,
                              double defaultValue,
                              TerminalProperties.DoubleChangeListener<T> listener)

Convenience method that adds a listener for the double property with the specified key.

Parameters:

key - the key of the property for which the listener is added.

defaultValue - the value to be used if the new value cannot be converted to a double.

listener - the listener to be added.

addBooleanListener

public void addBooleanListener(java.lang.String key,
                               boolean defaultValue,
                               TerminalProperties.BooleanChangeListener<T> listener)

Convenience method that adds a listener for the boolean property with the specified key.

Parameters:

key - the key of the property for which the listener is added.

defaultValue - the value to be used if the new value is null.

listener - the listener to be added.

setPromptColor

public void setPromptColor(java.lang.String color)

Convenience method that associates the specified color with the key

setPromptColor

public void setPromptColor(java.awt.Color color)

Convenience method that associates the hex representation of the specified color with the key

setPromptBackgroundColor

public void setPromptBackgroundColor(java.lang.String bgcolor)

Convenience method that associates the specified bgcolor with the key

setPromptBackgroundColor

public void setPromptBackgroundColor(java.awt.Color bgcolor)

Convenience method that associates the hex representation of the specified bgcolor with the key

setPromptBold

public void setPromptBold(boolean bold)

Convenience method that associates the boolean value bold with the key

setPromptItalic

public void setPromptItalic(boolean italic)

Convenience method that associates the boolean value italic with the key

setPromptUnderline

public void setPromptUnderline(boolean underline)

Convenience method that associates the boolean value underline with the key

setInputColor

public void setInputColor(java.lang.String color)

Convenience method that associates the specified color with the key

setInputColor

public void setInputColor(java.awt.Color color)

Convenience method that associates the hex representation of the specified color with the key

setInputBackgroundColor

public void setInputBackgroundColor(java.lang.String bgcolor)

Convenience method that associates the specified bgcolor with the key

setInputBackgroundColor

public void setInputBackgroundColor(java.awt.Color bgcolor)

Convenience method that associates the hex representation of the specified bgcolor with the key

setInputBold

public void setInputBold(boolean bold)

Convenience method that associates the boolean value bold with the key

setInputItalic

public void setInputItalic(boolean italic)

Convenience method that associates the boolean value italic with the key

setInputUnderline

public void setInputUnderline(boolean underline)

Convenience method that associates the boolean value underline with the key

setPaneBackgroundColor

public void setPaneBackgroundColor(java.lang.String bgcolor)

Convenience method that associates the specified bgcolor with the key

setPaneBackgroundColor

public void setPaneBackgroundColor(java.awt.Color bgcolor)

Convenience method that associates the hex representation of the specified bgcolor with the key

setPaneWidth

public void setPaneWidth(int width)

Convenience method that associates the specified width with the key

setPaneHeight

public void setPaneHeight(int height)

Convenience method that associates the specified height with the key

setPaneDimension

public void setPaneDimension(int width,
                             int height)

Convenience method that associates the specified width and height with the keys and