com.hume.DMH

Class StringList

Object

com.hume.DMH.StringList

All Implemented Interfaces:

Serializable, Cloneable

public class StringList
extends Object
implements Serializable, Cloneable

A class for parsing or building whitespace separated lists. Quotes " " or braces { } are used to enclose elements that contain whitespace. Whitespace refers to space, tab, newline, or carriage return ASCII characters. Indexing of list elements starts with 0. Lists are compatible with lists used by the Tcl programming language.

The ListBuilder class has better performance and is more convenient for creating lists.

This class is a revision of the TclList class made more convenient for use by not throwing exceptions except when attempting construction from improper text. The class does not offer the static list parsing methods that TclList does.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StringList() construct an empty list
StringList(String listText) Parse text that is formatted as a whitespace delimited list of elements.

Method Summary

Methods

Modifier and Type	Method and Description
String	get(int n) Retrieve an element from a list, indexing starts with 0.
String	join() return the string representation of your list created from joining the elements.
String	join(String separator) Join using a specified separator string.
void	lappend(String e) add an element to the list end
void	lappend(String e1, String e2) add 2 elements to the list end
void	lappend(String e1, String e2, String e3) add 3 elements to the list end
void	lappend(String e1, String e2, String e3, String e4) add 4 elements to the list end
int	length() Return the count of list elements.
String	lindex(int n) Retrieve an element from a list, indexing starts with 0.
void	linsert(String e, int index) Insert an element at index N, sliding existing elements +1.
int	llength() Return the count of list elements
static StringList	newList(String listStart) Construct a list beginning with the provided String value, returning null if the initial text is not proper.
void	remove(int index) remove a single element from the list
void	remove(int[] indexes) remove multiple elements
void	replace(int index, String element) Replace a single element in a list.
String[]	split() return the list elements as a String array
String	toString()

Methods inherited from class Object

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

Constructor Detail

StringList

public StringList()

construct an empty list

StringList

public StringList(String listText)
           throws ListFormatException

Parse text that is formatted as a whitespace delimited list of elements.

Parameters:

listText -

Throws:

ListFormatException - if the text is not a proper list because it contains unmatched quotes or unmatched braces or similar format errors.

Method Detail

get

public String get(int n)

Retrieve an element from a list, indexing starts with 0. An empty string "" is returned if the index is out of range. Equivalent to lindex(int n).

Returns:

the specified element or ""

join

public String join()

return the string representation of your list created from joining the elements.

Returns:

same value as toString()

join

public String join(String separator)

Join using a specified separator string.

Returns:

the string formed by joining the list elements together using the specified separator string between adjacent elements.

lappend

public void lappend(String e)

add an element to the list end

lappend

public void lappend(String e1,
           String e2)

add 2 elements to the list end

lappend

public void lappend(String e1,
           String e2,
           String e3)

add 3 elements to the list end

lappend

public void lappend(String e1,
           String e2,
           String e3,
           String e4)

add 4 elements to the list end

length

public int length()

Return the count of list elements.

Returns:

the list element count

lindex

public String lindex(int n)

Retrieve an element from a list, indexing starts with 0. An empty string "" is returned if the index is out of range.

Returns:

the specified element or ""

linsert

public void linsert(String e,
           int index)

Insert an element at index N, sliding existing elements +1. Indexing starts from 0.

llength

public int llength()

Return the count of list elements

Returns:

the count of list elements

newList

public static StringList newList(String listStart)

Construct a list beginning with the provided String value, returning null if the initial text is not proper. This is a "constructor" for knowledgeable users who are creating a new list when the text is known to be proper.

remove

public void remove(int index)

remove a single element from the list

remove

public void remove(int[] indexes)

remove multiple elements

replace

public void replace(int index,
           String element)

Replace a single element in a list.

split

public String[] split()

return the list elements as a String array

toString

public String toString()

Overrides:

toString in class Object