com.hume.DMH

Class ListBuilder

Object

com.hume.DMH.ListBuilder

public class ListBuilder
extends Object

A class for creating text structured as lists where whitespace, and {braces} are used to delimit list elements. These lists are compatible with the list formatting conventions of the Tcl language.

This class has less overhead than TclList or StringList for constructing lists and it does not throw Exceptions.

Constructor Summary

Constructors

Constructor and Description
ListBuilder()
ListBuilder(int n) Initialize with a specified character buffer size.
ListBuilder(String listStart) A constructor for character sequences that are valid whitespace delimited list elements.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() empty the list for re-use building a different list
void	lappend(int i) Append an integer as a list element.
void	lappend(long i) Append a long integer as a list element.
void	lappend(String e) Append a string value as a list element.
void	lappend(String[] sa) Append a string array as 0 or more list elements.
void	lappend(String s1, String s2) Append string values as list elements.
void	lappend(String s1, String s2, String s3)
void	lappend(String s1, String s2, String s3, String s4)
void	lappendSublist(String[] sa) Append a string array as a single sublist element.
void	lappendToken(String s) a higher performance lappend when it is known that a string is a simple alphanumeric token without interior spaces or special characters such as punctuation or control characters.
void	lappendToken(String s1, String s2) a higher performance lappend when it is known that a string is a simple alphanumeric token without interior spaces or special characters such as punctuation or control characters.
void	lappendToken(String s1, String s2, String s3) a higher performance lappend when it is known that a string is a simple alphanumeric token without interior spaces or special characters such as punctuation or control characters.
void	lappendToken(String s1, String s2, String s3, String s4) a higher performance lappend when it is known that a string is a simple alphanumeric token without interior spaces or special characters such as punctuation or control characters.
static String	list(int rc, String desc) Create a list from an integer code and a string value.
static String	list(int rc, String cmdToken, String desc) Create a list from an integer code, a text token, and a string.
static String	list(String[] args) Convert a String array to a String list.
static String	list(String s1, String s2) convenience method to format a list without explicit object construction
static String	list(String s1, String s2, String s3) convenience method to format a list without explicit object construction
static String	list(String s1, String s2, String s3, String s4) convenience method to format a list without explicit object construction
void	sublistEnd() End a nested sublist.
void	sublistStart() Begin a nested sublist.
String	toString() Obtain the current list value as a formatted String.

Methods inherited from class Object

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

Constructor Detail

ListBuilder

public ListBuilder()

ListBuilder

public ListBuilder(int n)

Initialize with a specified character buffer size.

Parameters:

n - - initial buffer size in characters

ListBuilder

public ListBuilder(String listStart)

A constructor for character sequences that are valid whitespace delimited list elements.

Parameters:

listStart - a sequence of whitespace delimited text list elements. There is no validation of a proper start to the list - this constructor is for knowledgeable users.

Method Detail

clear

public void clear()

empty the list for re-use building a different list

lappend

public void lappend(int i)

Append an integer as a list element.

Parameters:

i -

lappend

public void lappend(long i)

Append a long integer as a list element.

Parameters:

i -

lappend

public void lappend(String e)

Append a string value as a list element. The value may be null.

Parameters:

e -

lappend

public void lappend(String[] sa)

Append a string array as 0 or more list elements. The array may be null.

Parameters:

sa -

lappend

public void lappend(String s1,
           String s2)

Append string values as list elements. The values may be null.

Parameters:

s1 -

s2 -

lappend

public void lappend(String s1,
           String s2,
           String s3)

lappend

public void lappend(String s1,
           String s2,
           String s3,
           String s4)

lappendSublist

public void lappendSublist(String[] sa)

Append a string array as a single sublist element. The array may be null.

Parameters:

sa -

lappendToken

public void lappendToken(String s)

a higher performance lappend when it is known that a string is a simple alphanumeric token without interior spaces or special characters such as punctuation or control characters.

lappendToken

public void lappendToken(String s1,
                String s2)

a higher performance lappend when it is known that a string is a simple alphanumeric token without interior spaces or special characters such as punctuation or control characters.

lappendToken

public void lappendToken(String s1,
                String s2,
                String s3)

a higher performance lappend when it is known that a string is a simple alphanumeric token without interior spaces or special characters such as punctuation or control characters.

lappendToken

public void lappendToken(String s1,
                String s2,
                String s3,
                String s4)

a higher performance lappend when it is known that a string is a simple alphanumeric token without interior spaces or special characters such as punctuation or control characters.

list

public static String list(int rc,
          String desc)

Create a list from an integer code and a string value.

Parameters:

rc -

desc -

Returns:

list text

list

public static String list(int rc,
          String cmdToken,
          String desc)

Create a list from an integer code, a text token, and a string. The text token consists of ordinary alphanumeric characters with no embedded whitespace.

Parameters:

rc -

cmdToken -

desc -

Returns:

list text

list

public static String list(String[] args)

Convert a String array to a String list. See TclList.split() for the opposite direction.

Parameters:

args - list elements as a String array

Returns:

a list result

list

public static String list(String s1,
          String s2)

convenience method to format a list without explicit object construction

list

public static String list(String s1,
          String s2,
          String s3)

convenience method to format a list without explicit object construction

list

public static String list(String s1,
          String s2,
          String s3,
          String s4)

convenience method to format a list without explicit object construction

sublistEnd

public void sublistEnd()

End a nested sublist.

sublistStart

public void sublistStart()

Begin a nested sublist.

 ...
 mylist.lappend("one");
 mylist.sublistStart();
     mylist.lappend("two", "three", "hello world");
 mylist.sublistEnd();
 System.out.println(mylist.toString());
 "one {two three {hello world}}"
 

toString

public String toString()

Obtain the current list value as a formatted String.

Overrides:

toString in class Object