Package fr.dyade.aaa.common

Class Strings

java.lang.Object

fr.dyade.aaa.common.Strings

public class Strings
extends Object

This class provides a set of static functions for building string representations of complex structures.

Field Summary

Fields

Modifier and Type	Field	Description
static int	listBorder	Controls the default formatting of lists of objects.
static int	listMax	Controls the default formatting of lists of objects.

Constructor Summary

Constructors

Constructor	Description
Strings()

Method Summary

Modifier and Type	Method	Description
static void	toByteArray(ByteArrayOutputStream output, String str)	Provides a Java string literal representing the parameter string.
static String	toString(Object obj)	Provides a string representation of an object.
static String	toString(String str)	Provides a Java string literal representing the parameter string.
static void	toString(StringBuilder output, boolean[] tab)	Provides a string representation of an array of booleans.
static void	toString(StringBuilder output, boolean[] tab, int listMax, int listBorder)	Provides a string representation of an array of booleans.
static void	toString(StringBuilder output, byte[] tab)	Provides a string representation of an array of bytes.
static void	toString(StringBuilder output, byte[] tab, int listMax, int listBorder)	Provides a string representation of an array of bytes.
static void	toString(StringBuilder output, char[] tab)	Provides a string representation of an array of chars.
static void	toString(StringBuilder output, char[] tab, int listMax, int listBorder)	Provides a string representation of an array of chars.
static void	toString(StringBuilder output, double[] tab)	Provides a string representation of an array of doubles.
static void	toString(StringBuilder output, double[] tab, int listMax, int listBorder)	Provides a string representation of an array of doubles.
static void	toString(StringBuilder output, float[] tab)	Provides a string representation of an array of floats.
static void	toString(StringBuilder output, float[] tab, int listMax, int listBorder)	Provides a string representation of an array of floats.
static void	toString(StringBuilder output, int[] tab)	Provides a string representation of an array of ints.
static void	toString(StringBuilder output, int[] tab, int listMax, int listBorder)	Provides a string representation of an array of ints.
static void	toString(StringBuilder output, long[] tab)	Provides a string representation of an array of longs.
static void	toString(StringBuilder output, long[] tab, int listMax, int listBorder)	Provides a string representation of an array of longs.
static void	toString(StringBuilder output, short[] tab)	Provides a string representation of an array of shorts.
static void	toString(StringBuilder output, short[] tab, int listMax, int listBorder)	Provides a string representation of an array of shorts.
static void	toString(StringBuilder output, Object obj)	Provides a string representation of an object.
static void	toString(StringBuilder output, Object[] tab)	Provides a string representation of an array of objects.
static void	toString(StringBuilder output, Object[] tab, int listMax, int listBorder)	Provides a string representation of an array of objects.
static void	toString(StringBuilder output, Object obj, Class<?> type)	Provides a string representation of an array.
static void	toString(StringBuilder output, Object obj, Class<?> type, int listMax, int listBorder)	Provides a string representation of an array.
static void	toString(StringBuilder output, String str)	Provides a Java string literal representing the parameter string.
static void	toString(StringBuilder output, Collection<?> set)	Provides a string representation of an unordered Collection of objects.
static void	toString(StringBuilder output, Collection<?> set, int listMax, int listBorder)	Provides a string representation of an unordered Collection of objects.
static void	toString(StringBuilder output, List<?> list)	Provides a string representation of a list of objects.
static void	toString(StringBuilder output, List<?> list, int listMax, int listBorder)	Provides a string representation of a list of objects.
static void	toString(StringBuilder output, Map.Entry<?,?> entry)	Provides a string representation of a Map entry.
static void	toString(StringBuilder output, Map<?,?> map)	Provides a string representation of a Map.
static String	toString(Collection<?> set)	Provides a string representation of an unordered Collection of objects.
static String	toString(List<?> list)	Provides a string representation of a list of objects.
static String	toString(Map<?,?> map)	Provides a string representation of a Map.
static String	toStringArray(Object tab)	Provides a string representation of an array.
static void	toStringArray(StringBuilder output, Object tab)	Provides a string representation of an array.

Methods inherited from class java.lang.Object

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

Field Detail

listMax

public static int listMax

Controls the default formatting of lists of objects. By default lists with a number of elements up to listMax are entirely printed. A value of -1 leads to complete printing of the list, whatever its size.

This variable, when used in an agent server, may be set by the debug variable Debug.var.fr.dyade.aaa.util.listMax. Its default value is 10.

listBorder

public static int listBorder

Controls the default formatting of lists of objects. By default lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

This variable, when used in an agent server, may be set by the debug variable Debug.var.fr.dyade.aaa.util.listBorder. Its default value is is 3.

Constructor Detail

Strings

public Strings()

Method Detail

toString

public static final void toString(StringBuilder output,
                                  Object obj)

Provides a string representation of an object. Checks if there exists in this class a specialized toString function for the object class, or calls the toString function of the object.

Parameters:

output - a buffer to print the object into

obj - the object to print

toString

public static final String toString(Object obj)

Provides a string representation of an object. Calls toString(StringBuilder).

Parameters:

obj - the object to print

Returns:

a string representation of the object

toByteArray

public static final void toByteArray(ByteArrayOutputStream output,
                                     String str)

Provides a Java string literal representing the parameter string. This includes surrounding double quotes, and quoted special characters, including UTF escape sequences when necessary.

This function works only for ASCII character encoding, and assumes this is the default encoding.

Parameters:

output - a byte buffer to print the object into

str - the string to print

toString

public static final void toString(StringBuilder output,
                                  String str)

Provides a Java string literal representing the parameter string. This includes surrounding double quotes, and quoted special characters, including UTF escape sequences when necessary.

This function works only for ASCII character encoding, and assumes this is the default encoding.

Parameters:

output - a string buffer to print the object into

str - the string to print

toString

public static final String toString(String str)

Provides a Java string literal representing the parameter string. This includes surrounding double quotes, and quoted special characters, including UTF escape sequences when necessary.

This function works only for ASCII character encoding, and assumes this is the default encoding.

Parameters:

str - the string to print

Returns:

a Java string literal representation of the string

toString

public static final void toString(StringBuilder output,
                                  Object obj,
                                  Class<?> type)

Provides a string representation of an array.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

Parameters:

output - a buffer to print the object into

obj - the array to print

type - the type of the array components

See Also:

listMax, listBorder

toString

public static final void toString(StringBuilder output,
                                  Object obj,
                                  Class<?> type,
                                  int listMax,
                                  int listBorder)

Provides a string representation of an array.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements. A value of -1 for listMax leads to complete printing of the list, whatever its size.

Parameters:

output - a buffer to print the object into

obj - the array to print

type - the type of the array components

listMax - Controls the formatting of lists of objects.

listBorder - Controls the formatting of lists of objects.

toStringArray

public static final void toStringArray(StringBuilder output,
                                       Object tab)

Provides a string representation of an array. Calls toString(StringBuilder, Object, Class).

Parameters:

output - a buffer to print the object into

tab - the array to print

toStringArray

public static final String toStringArray(Object tab)

Provides a string representation of an array. Calls toString(StringBuilder, Object, Class).

Parameters:

tab - the array to print

Returns:

a string representation of the array

See Also:

toString(StringBuilder, Object, Class)

toString

public static final void toString(StringBuilder output,
                                  boolean[] tab)

Provides a string representation of an array of booleans.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

Parameters:

output - a buffer to print the object into

tab - the array to print

See Also:

listMax, listBorder

toString

public static final void toString(StringBuilder output,
                                  boolean[] tab,
                                  int listMax,
                                  int listBorder)

Provides a string representation of an array of booleans.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

A value of -1 for listMax leads to complete printing of the list, whatever its size.

Parameters:

output - a buffer to print the object into

tab - the array to print

listMax - Controls the formatting of lists of objects.

listBorder - Controls the formatting of lists of objects.

toString

public static final void toString(StringBuilder output,
                                  byte[] tab)

Provides a string representation of an array of bytes.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

Parameters:

output - a buffer to print the object into

tab - the array to print

See Also:

listMax, listBorder

toString

public static final void toString(StringBuilder output,
                                  byte[] tab,
                                  int listMax,
                                  int listBorder)

Provides a string representation of an array of bytes.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

A value of -1 for listMax leads to complete printing of the list, whatever its size.

Parameters:

output - a buffer to print the object into

tab - the array to print

listMax - Controls the formatting of lists of objects.

listBorder - Controls the formatting of lists of objects.

toString

public static final void toString(StringBuilder output,
                                  char[] tab)

Provides a string representation of an array of chars.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

Parameters:

output - a buffer to print the object into

tab - the array to print

See Also:

listMax, listBorder

toString

public static final void toString(StringBuilder output,
                                  char[] tab,
                                  int listMax,
                                  int listBorder)

Provides a string representation of an array of chars.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

A value of -1 for listMax leads to complete printing of the list, whatever its size.

Parameters:

output - a buffer to print the object into

tab - the array to print

listMax - Controls the formatting of lists of objects.

listBorder - Controls the formatting of lists of objects.

toString

public static final void toString(StringBuilder output,
                                  short[] tab)

Provides a string representation of an array of shorts.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

Parameters:

output - a buffer to print the object into

tab - the array to print

See Also:

listMax, listBorder

toString

public static final void toString(StringBuilder output,
                                  short[] tab,
                                  int listMax,
                                  int listBorder)

Provides a string representation of an array of shorts.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

A value of -1 for listMax leads to complete printing of the list, whatever its size.

Parameters:

output - a buffer to print the object into

tab - the array to print

listMax - Controls the formatting of lists of objects.

listBorder - Controls the formatting of lists of objects.

toString

public static final void toString(StringBuilder output,
                                  int[] tab)

Provides a string representation of an array of ints.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

Parameters:

output - a buffer to print the object into

tab - the array to print

See Also:

listMax, listBorder

toString

public static final void toString(StringBuilder output,
                                  int[] tab,
                                  int listMax,
                                  int listBorder)

Provides a string representation of an array of ints.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

A value of -1 for listMax leads to complete printing of the list, whatever its size.

Parameters:

output - a buffer to print the object into

tab - the array to print

listMax - Controls the formatting of lists of objects.

listBorder - Controls the formatting of lists of objects.

toString

public static final void toString(StringBuilder output,
                                  long[] tab)

Provides a string representation of an array of longs.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

Parameters:

output - a buffer to print the object into

tab - the array to print

See Also:

listMax, listBorder

toString

public static final void toString(StringBuilder output,
                                  long[] tab,
                                  int listMax,
                                  int listBorder)

Provides a string representation of an array of longs.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

A value of -1 for listMax leads to complete printing of the list, whatever its size.

Parameters:

output - a buffer to print the object into

tab - the array to print

listMax - Controls the formatting of lists of objects.

listBorder - Controls the formatting of lists of objects.

toString

public static final void toString(StringBuilder output,
                                  float[] tab)

Provides a string representation of an array of floats.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

Parameters:

output - a buffer to print the object into

tab - the array to print

See Also:

listMax, listBorder

toString

public static final void toString(StringBuilder output,
                                  float[] tab,
                                  int listMax,
                                  int listBorder)

Provides a string representation of an array of floats.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

A value of -1 for listMax leads to complete printing of the list, whatever its size.

Parameters:

output - a buffer to print the object into

tab - the array to print

listMax - Controls the formatting of lists of objects.

listBorder - Controls the formatting of lists of objects.

toString

public static final void toString(StringBuilder output,
                                  double[] tab)

Provides a string representation of an array of doubles.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

Parameters:

output - a buffer to print the object into

tab - the array to print

See Also:

listMax, listBorder

toString

public static final void toString(StringBuilder output,
                                  double[] tab,
                                  int listMax,
                                  int listBorder)

Provides a string representation of an array of doubles.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

A value of -1 for listMax leads to complete printing of the list, whatever its size.

Parameters:

output - a buffer to print the object into

tab - the array to print

listMax - Controls the formatting of lists of objects.

listBorder - Controls the formatting of lists of objects.

toString

public static final void toString(StringBuilder output,
                                  Object[] tab)

Provides a string representation of an array of objects.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

Parameters:

output - a buffer to print the object into

tab - the array to print

See Also:

listMax, listBorder

toString

public static final void toString(StringBuilder output,
                                  Object[] tab,
                                  int listMax,
                                  int listBorder)

Provides a string representation of an array of objects.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

A value of -1 for listMax leads to complete printing of the list, whatever its size.

Parameters:

output - a buffer to print the object into

tab - the array to print

listMax - Controls the formatting of lists of objects.

listBorder - Controls the formatting of lists of objects.

toString

public static final void toString(StringBuilder output,
                                  List<?> list)

Provides a string representation of a list of objects. This includes Vectors.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

Parameters:

output - a buffer to print the object into

list - the list of Object objects to print

See Also:

listMax, listBorder

toString

public static final void toString(StringBuilder output,
                                  List<?> list,
                                  int listMax,
                                  int listBorder)

Provides a string representation of a list of objects. This includes Vectors.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

A value of -1 for listMax leads to complete printing of the list, whatever its size.

Parameters:

output - a buffer to print the object into

list - the list of Object objects to print

listMax - Controls the formatting of lists of objects.

listBorder - Controls the formatting of lists of objects.

toString

public static final String toString(List<?> list)

Provides a string representation of a list of objects. Calls toString(StringBuilder, ...).

Parameters:

list - the list of Object objects to print

Returns:

a string representation of the list

toString

public static final void toString(StringBuilder output,
                                  Collection<?> set)

Provides a string representation of an unordered Collection of objects. This includes HashSets.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

Parameters:

output - a buffer to print the object into

set - the collection to print

See Also:

listMax, listBorder

toString

public static final void toString(StringBuilder output,
                                  Collection<?> set,
                                  int listMax,
                                  int listBorder)

Provides a string representation of an unordered Collection of objects. This includes HashSets.

Lists with a number of elements greater than listMax are partially printed, with the listBorder leading and trailing elements.

A value of -1 for listMax leads to complete printing of the list, whatever its size.

Parameters:

output - a buffer to print the object into

set - the collection to print

listMax - Controls the formatting of lists of objects.

listBorder - Controls the formatting of lists of objects.

toString

public static final String toString(Collection<?> set)

Provides a string representation of an unordered Collection of objects. Calls toString(StringBuilder, ...).

Parameters:

set - the collection to print

Returns:

a string representation of the list

toString

public static final void toString(StringBuilder output,
                                  Map<?,?> map)

Provides a string representation of a Map. This includes HashTables. Uses the listMax and listBorder variables.

Parameters:

output - a buffer to print the object into

map - the map to print

toString

public static final String toString(Map<?,?> map)

Provides a string representation of a Map. Calls toString(StringBuilder, ...).

Parameters:

map - the map to print

Returns:

a string representation of the map

toString

public static final void toString(StringBuilder output,
                                  Map.Entry<?,?> entry)

Provides a string representation of a Map entry.

Parameters:

output - a buffer to print the object into

entry - the map entry to print