fr.dyade.aaa.util
Class Strings

java.lang.Object
  fr.dyade.aaa.util.Strings

public class Strings

extends java.lang.Object

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

Field Summary

static int	listBorder Controls the formatting of lists of objects.
static int	listMax Controls the formatting of lists of objects.

Constructor Summary

Strings()

Method Summary

static void	toByteArray(java.io.ByteArrayOutputStream output, java.lang.String str) Provides a Java string literal representing the parameter string.
static java.lang.String	toString(java.util.Hashtable table) Provides a string representation of a hash table of objects.
static java.lang.String	toString(java.lang.Object obj) Provides a string representation of an object.
static java.lang.String	toString(java.lang.String str) Provides a Java string literal representing the parameter string.
static void	toString(java.lang.StringBuffer output, boolean[] tab) Provides a string representation of an array of booleans.
static void	toString(java.lang.StringBuffer output, byte[] tab) Provides a string representation of an array of bytes.
static void	toString(java.lang.StringBuffer output, char[] tab) Provides a string representation of an array of chars.
static void	toString(java.lang.StringBuffer output, double[] tab) Provides a string representation of an array of doubles.
static void	toString(java.lang.StringBuffer output, float[] tab) Provides a string representation of an array of floats.
static void	toString(java.lang.StringBuffer output, java.util.Hashtable table) Provides a string representation of a hash table of objects.
static void	toString(java.lang.StringBuffer output, int[] tab) Provides a string representation of an array of ints.
static void	toString(java.lang.StringBuffer output, long[] tab) Provides a string representation of an array of longs.
static void	toString(java.lang.StringBuffer output, java.lang.Object obj) Provides a string representation of an object.
static void	toString(java.lang.StringBuffer output, java.lang.Object obj, java.lang.Class type) Provides a string representation of an array.
static void	toString(java.lang.StringBuffer output, short[] tab) Provides a string representation of an array of shorts.
static void	toString(java.lang.StringBuffer output, java.lang.String str) Provides a Java string literal representing the parameter string.
static void	toString(java.lang.StringBuffer output, java.util.Vector vector) Provides a string representation of a vector of objects.
static java.lang.String	toString(java.util.Vector vector) Provides a string representation of a vector of objects.
static java.lang.String	toStringArray(java.lang.Object tab) Provides a string representation of an array.
static void	toStringArray(java.lang.StringBuffer output, java.lang.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 formatting of lists of objects. 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 formatting of lists of objects. 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 3.

Constructor Detail

Strings

public Strings()

Method Detail

toString

public static final void toString(java.lang.StringBuffer output,
                                  java.lang.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 java.lang.String toString(java.lang.Object obj)

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

Parameters:

obj - the object to print

Returns:

a string representation of the object

toByteArray

public static final void toByteArray(java.io.ByteArrayOutputStream output,
                                     java.lang.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(java.lang.StringBuffer output,
                                  java.lang.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 java.lang.String toString(java.lang.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(java.lang.StringBuffer output,
                                  java.lang.Object obj,
                                  java.lang.Class type)

Provides a string representation of an array. Uses the listMax and listBorder variables.

Parameters:

output - a buffer to print the object into

obj - the array to print

type - the type of the array components

toStringArray

public static final void toStringArray(java.lang.StringBuffer output,
                                       java.lang.Object tab)

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

Parameters:

output - a buffer to print the object into

tab - the array to print

toStringArray

public static final java.lang.String toStringArray(java.lang.Object tab)

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

Parameters:

tab - the array to print

Returns:

a string representation of the array

toString

public static final void toString(java.lang.StringBuffer output,
                                  boolean[] tab)

Provides a string representation of an array of booleans. Uses the listMax and listBorder variables.

Parameters:

output - a buffer to print the object into

tab - the array to print

toString

public static final void toString(java.lang.StringBuffer output,
                                  byte[] tab)

Provides a string representation of an array of bytes. Uses the listMax and listBorder variables.

Parameters:

output - a buffer to print the object into

tab - the array to print

toString

public static final void toString(java.lang.StringBuffer output,
                                  char[] tab)

Provides a string representation of an array of chars. Uses the listMax and listBorder variables.

Parameters:

output - a buffer to print the object into

tab - the array to print

toString

public static final void toString(java.lang.StringBuffer output,
                                  short[] tab)

Provides a string representation of an array of shorts. Uses the listMax and listBorder variables.

Parameters:

output - a buffer to print the object into

tab - the array to print

toString

public static final void toString(java.lang.StringBuffer output,
                                  int[] tab)

Provides a string representation of an array of ints. Uses the listMax and listBorder variables.

Parameters:

output - a buffer to print the object into

tab - the array to print

toString

public static final void toString(java.lang.StringBuffer output,
                                  long[] tab)

Provides a string representation of an array of longs. Uses the listMax and listBorder variables.

Parameters:

output - a buffer to print the object into

tab - the array to print

toString

public static final void toString(java.lang.StringBuffer output,
                                  float[] tab)

Provides a string representation of an array of floats. Uses the listMax and listBorder variables.

Parameters:

output - a buffer to print the object into

tab - the array to print

toString

public static final void toString(java.lang.StringBuffer output,
                                  double[] tab)

Provides a string representation of an array of doubles. Uses the listMax and listBorder variables.

Parameters:

output - a buffer to print the object into

tab - the array to print

toString

public static final void toString(java.lang.StringBuffer output,
                                  java.util.Vector vector)

Provides a string representation of a vector of objects. Uses the listMax and listBorder variables.

Parameters:

output - a buffer to print the object into

vector - the vector of Object objects to print

toString

public static final java.lang.String toString(java.util.Vector vector)

Provides a string representation of a vector of objects. Calls toString(StringBuffer, ...).

Parameters:

vector - the vector of Object objects to print

Returns:

a string representation of the vector

toString

public static final void toString(java.lang.StringBuffer output,
                                  java.util.Hashtable table)

Provides a string representation of a hash table of objects. Uses the listMax and listBorder variables.

Parameters:

output - a buffer to print the object into

table - the table of Object objects to print

toString

public static final java.lang.String toString(java.util.Hashtable table)

Provides a string representation of a hash table of objects. Calls toString(StringBuffer, ...).

Parameters:

table - the table of Object objects to print

Returns:

a string representation of the table