com.webmethods.caf.common

Class ListTools

java.lang.Object

com.webmethods.caf.common.ListTools

public class ListTools
extends Object

Converts Strings to Lists and vice-versa, using Property Editor rules.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListTools.EnumerationIterator Inner class that iterates through enumerations.

Constructor Summary

Constructors

Constructor and Description
ListTools()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	addToMap(Map aMap, String aString) Auxiliary method for stringToMapInternal().
static String	collectionToString(Collection c) Converts Collection to String.
static Collection	iteratorToCollection(Iterator i) Converts Iterator to Collection.
static List	iteratorToList(Iterator i) Converts Iterator to List.
static String	iteratorToString(Iterator i) Converts Iterator to String.
protected static String	listToString_ibm(List l) Convert list to string comma separated
static String	listToString(List l) Converts List to String.
static List	mapToList(Map m) Converts Map to List.
static String	mapToString(Map m) Converts Map to String.
static Collection	objectToCollection(Object o) Converts Iterator to Collection.
static List	objectToList(Object o) Converts Iterator to List.
static String	objectToString(Object o) Converts Object to String.
static List	stringToList(String s) Converts String to List.
static Map	stringToMap(String aString) Converts String to Map.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListTools

public ListTools()

Method Detail

stringToList

public static List stringToList(String s)

Converts String to List.

1. Split string on ','. (except when escaped by '\\': "\\,").
2. Trim whitespace from each sub-string.
3. Add each sub-string to list, including empty sub-strings.

Parameters:

s - String or null.

Returns:

Non-null immutable list.

See Also:

ListTools.listToString(java.util.List)

iteratorToList

public static List iteratorToList(Iterator i)

Converts Iterator to List.

Parameters:

i - Iterator or null.

Returns:

Non-null immutable list.

mapToList

public static List mapToList(Map m)

Converts Map to List. Converts each entry in map to name=value string (convert nulls to ""). Characters '=' are not converted to "\\=". They are not expected in this method.

Parameters:

m - Map or null.

Returns:

Non-null string.

See Also:

ListTools.stringToList(java.lang.String)

objectToList

public static List objectToList(Object o)

Converts Iterator to List. If object is string, uses ListTools.stringToList(java.lang.String).

Parameters:

o - Object or null.

Returns:

Non-null immutable list.

iteratorToCollection

public static Collection iteratorToCollection(Iterator i)

Converts Iterator to Collection.

Parameters:

i - Iterator or null.

Returns:

Non-null immutable list.

objectToCollection

public static Collection objectToCollection(Object o)

Converts Iterator to Collection. If object is string, uses ListTools.stringToList(java.lang.String).

Parameters:

o - Object or null.

Returns:

Non-null immutable list.

stringToMap

public static Map stringToMap(String aString)

Converts String to Map.

1. Split string on ','. (except when escaped by '\\': "\\,").
2. Split sub-strings on '=' into name,value pairs.
3. If the name or the value contains "\\=", convert it to '='.
4. Trim whitespace from each name and value.
5. Add each name,value pair to map, including those with empty names and or values.

Parameters:

s - String or null.

Returns:

Non-null immutable map.

See Also:

ListTools.mapToString(java.util.Map)

addToMap

protected static void addToMap(Map aMap,
            String aString)

Auxiliary method for stringToMapInternal(). Splits the string on two based on the first occurance of a non-escaped equals character '='. Adds an entry in the map based on the split. The key of the entry is the left substring of the split and the value is the right substring of the split. If there is an escaped equals character, e.g. "\\=", it is saved as a normal equals character in the key or the value of the entry. If there are other characters which are escaped via "\\", they are also converted to their normal value. Examples: "x=1": {"x" => "1"} "x=1=2": {"x" => "1=2"} "x=1\\=2": {"x" => "1=2"} "x\\=y=1\\=2": {"x=y" => "1=2"} "x1": {"x1" => ""} "x\\=1": {"x=1" => ""}

listToString

public static String listToString(List l)

Converts List to String.

1. Convert each item in list to string (convert nulls to "").
2. Convert ',' char to "\\,".
3. Concatonate items with ','.

Parameters:

l - List or null.

Returns:

Non-null string.

See Also:

ListTools.stringToList(java.lang.String)

listToString_ibm

protected static String listToString_ibm(List l)

Convert list to string comma separated

Parameters:

l - list or null

Returns:

string representation of l

mapToString

public static String mapToString(Map m)

Converts Map to String.

1. Convert each entry in the map to a name=value string (convert nulls to "").
2. Convert ',' char to "\\,".
3. Convert '=' char to "\\=".
4. Concatenate entries with ','.

Parameters:

m - Map or null.

Returns:

Non-null string.

See Also:

ListTools.stringToList(java.lang.String)

iteratorToString

public static String iteratorToString(Iterator i)

Converts Iterator to String.

1. Convert each item in the list to a string (convert nulls to "").
2. Convert ',' char to "\\,".
3. Concatenate entries with ','.

Parameters:

i - Iterator or null.

Returns:

Non-null string.

See Also:

ListTools.stringToList(java.lang.String)

collectionToString

public static String collectionToString(Collection c)

Converts Collection to String.

1. Convert each item in the list to a string (convert nulls to "").
2. Convert ',' char to "\\,".
3. Concatenate entries with ','.

Parameters:

c - Colection or null.

Returns:

Non-null string.

See Also:

ListTools.stringToList(java.lang.String)

objectToString

public static String objectToString(Object o)

Converts Object to String. If object is collection, uses ListTools.collectionToString(java.util.Collection).

Parameters:

o - Object or null.

Returns:

Non-null string.

See Also:

ListTools.stringToList(java.lang.String)