org.tmotte.common.text

Class DelimitedString

java.lang.Object

org.tmotte.common.text.DelimitedString

All Implemented Interfaces:

Appender

public class DelimitedString
extends java.lang.Object
implements Appender

Simple class for building a String that is delimited by commas or brackets or whatever. Maintains an internal list to which objects are added, then concatenates everything in toString() and appendTo(). Note that objects added to a DelimitedString are not toString()'d themselves until DelimitedString.toString() is called.

Constructor Summary

Constructors

Constructor and Description
DelimitedString(java.lang.String between) Same as new DelimitedString("", between, "", "", "");
DelimitedString(java.lang.String initial, java.lang.String between) Same as new DelimitedString(initial, between, "", "", "");
DelimitedString(java.lang.String initial, java.lang.String between, java.lang.String last) Same as new DelimitedString(initial, between, last, "", "");
DelimitedString(java.lang.String initial, java.lang.String between, java.lang.String last, java.lang.String beforeEach, java.lang.String afterEach) Sets all the possible delimiters.

Method Summary

Modifier and Type	Method and Description
DelimitedString	add(java.lang.Object object) Adds object to the internal list.
DelimitedString	addEach(java.util.Enumeration list) Adds each member of list individually.
DelimitedString	addEach(java.util.Iterator list) Adds each member of list individually.
DelimitedString	addEach(java.util.List list) Adds each member of list individually.
DelimitedString	addEach(java.lang.Object[] list) Adds each member of list individually.
void	appendTo(java.lang.Appendable a) Fulfills the Appender interface.
void	clear() Clears the internal list of data.
static void	main(java.lang.String[] args) Used for unit test.
int	size() Obtains the size of the internal list.
java.lang.String	toString() Converts the internal list to a String by toString()'ing list members and concatenating them together in order, delimited by the various delimiters passed to the constructor.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelimitedString

public DelimitedString(java.lang.String between)

Same as new DelimitedString("", between, "", "", "");

Parameters:

between - Will go between items.

DelimitedString

public DelimitedString(java.lang.String initial,
                       java.lang.String between)

Same as new DelimitedString(initial, between, "", "", "");

Parameters:

initial - Will go before first item.

between - Will go after each additional item except last.

DelimitedString

public DelimitedString(java.lang.String initial,
                       java.lang.String between,
                       java.lang.String last)

Same as new DelimitedString(initial, between, last, "", "");

Parameters:

initial - Will go before first item.

between - Will go after each additional item except last.

last - Will go after last item.

DelimitedString

public DelimitedString(java.lang.String initial,
                       java.lang.String between,
                       java.lang.String last,
                       java.lang.String beforeEach,
                       java.lang.String afterEach)

Sets all the possible delimiters. When printed, the DelimitedString will insert these delimiters around list members as they are concatenated together. Null parameters for this constructor will be treated as blanks ("").
For example, the two-item list "a" "b" will be formatted as:

   
      [initial][beforeEach]a[afterEach][between][beforeEach]b[afterEach][last]
      

As another example, to generate a comma-separated-values (CSV) record, the constructor would be invoked as:

   
      new DelimitedString(null, ",", null, "\"", "\"");
      

Parameters:

initial - Goes before first item.

between - Is only used if there is more than one item. Goes after each item except the last one.

last - Goes after last item.

beforeEach - This goes immediately before each item; for the first item, goes after initial but before the item.

afterEach - This goes immediately after each item; for the last item, goes after the item, but before last.

Method Detail

size

public int size()

Obtains the size of the internal list.

clear

public void clear()

Clears the internal list of data. Does not affect any of the delimiters.

add

public final DelimitedString add(java.lang.Object object)

Adds object to the internal list.

addEach

public DelimitedString addEach(java.util.Enumeration list)

Adds each member of list individually.

addEach

public DelimitedString addEach(java.util.Iterator list)

Adds each member of list individually.

addEach

public DelimitedString addEach(java.util.List list)

Adds each member of list individually.

addEach

public DelimitedString addEach(java.lang.Object[] list)

Adds each member of list individually.

appendTo

public void appendTo(java.lang.Appendable a)

Fulfills the Appender interface. Similar to toString(), but is more efficient to use when you know what you want to write the DelimitedString to, since it eliminates the need for an internal text buffer (e.g. StringBuilder/StringBuffer).

Specified by:

appendTo in interface Appender

toString

public java.lang.String toString()

Converts the internal list to a String by toString()'ing list members and concatenating them together in order, delimited by the various delimiters passed to the constructor.

Overrides:

toString in class java.lang.Object

Returns:

"" if nothing has been added.

main

public static void main(java.lang.String[] args)

Used for unit test.