global

Class ListString

java.lang.Object

global.ListString

public class ListString
extends java.lang.Object

Class for creating a user-readable string representation of a list.

Author:

Andreas Fender

Constructor Summary

Constructors

Constructor and Description
ListString() Initializes the instance with ", " as the separator, ": " as key-value-separator and "<>" as empty string.
ListString(java.lang.String separator) Initializes the instance with ": " as key value separator and "<>" as empty string.
ListString(java.lang.String separator, java.lang.String keyValueSeparator, java.lang.String emptyString) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	append(java.lang.Object object) Appends the string representation of the given object to the result string.
void	append(java.lang.String key, java.lang.Object object) Appends the given key and the given object separated by the key-value-separator.
int	getElemCount() Returns the number of elements which were appended.
java.lang.String	getResult() Returns the resulting string representation.
java.lang.String	getResult(int maxCharCount) Returns the resulting string representation, whereas the number of characters is limited to the given value.
boolean	isEmpty() Returns true, if and only if no element has been appended yet.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ListString

public ListString(java.lang.String separator,
          java.lang.String keyValueSeparator,
          java.lang.String emptyString)

Creates a new instance.

Parameters:

separator - the separator to separate the entries of the list output.

keyValueSeparator - the separator for key value pairs (when calling append(String key,Object object)).

emptyString - the string which is to be returned, if the list is empty.

ListString

public ListString(java.lang.String separator)

Initializes the instance with ": " as key value separator and "<>" as empty string.

Parameters:

separator - the separator to separate the entries of the list output.

ListString

public ListString()

Initializes the instance with ", " as the separator, ": " as key-value-separator and "<>" as empty string.

Method Detail

append

public void append(java.lang.Object object)

Appends the string representation of the given object to the result string. If the object is an instance of StringRepresentation, then object.getStringRepresentation is used. Otherwise object.toString is used.

Parameters:

object - the object of which to add the string representation.

append

public void append(java.lang.String key,
          java.lang.Object object)

Appends the given key and the given object separated by the key-value-separator.

Parameters:

key - the key to append.

object - the object of which to add the string representation.

getResult

public java.lang.String getResult()

Returns the resulting string representation.

Returns:

the resulting string or the empty string given in the constructor if the resulting string is empty.

getResult

public java.lang.String getResult(int maxCharCount)

Returns the resulting string representation, whereas the number of characters is limited to the given value. If the result is larger than the given limit, then it is truncated and three dots are appended.

Parameters:

maxCharCount - the maximum character count of the result.

Returns:

the resulting string.

isEmpty

public boolean isEmpty()

Returns true, if and only if no element has been appended yet.

Returns:

true, if and only if no element has been appended yet.

getElemCount

public int getElemCount()

Returns the number of elements which were appended.

Returns:

the number of elements which were appended.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object