fr.dyade.aaa.util.Strings

fr.dyade.aaa.util.Strings Class Reference

List of all members.

Static Public Member Functions

static final void toString (StringBuffer output, Object obj)
static final String toString (Object obj)
static final void toByteArray (ByteArrayOutputStream output, String str)
static final void toString (StringBuffer output, String str)
static final String toString (String str)
static final void toString (StringBuffer output, Object obj, Class type)
static final void toStringArray (StringBuffer output, Object tab)
static final String toStringArray (Object tab)
static final void toString (StringBuffer output, boolean[] tab)
static final void toString (StringBuffer output, byte[] tab)
static final void toString (StringBuffer output, char[] tab)
static final void toString (StringBuffer output, short[] tab)
static final void toString (StringBuffer output, int[] tab)
static final void toString (StringBuffer output, long[] tab)
static final void toString (StringBuffer output, float[] tab)
static final void toString (StringBuffer output, double[] tab)
static final void toString (StringBuffer output, List list)
static final String toString (List list)
static final void toString (StringBuffer output, Collection set)
static final String toString (Collection set)
static final void toString (StringBuffer output, Map map)
static final String toString (Map map)
static final void toString (StringBuffer output, Map.Entry entry)

Static Public Attributes

static int listMax = 10
static int listBorder = 3

Detailed Description

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

Definition at line 36 of file Strings.java.

Member Function Documentation

static final void fr.dyade.aaa.util.Strings.toString ( StringBuffer  output,
Object  obj 
) [static]

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

Definition at line 45 of file Strings.java.

Referenced by fr.dyade.aaa.util.Strings.toString(), and fr.dyade.aaa.util.Strings.toStringArray().

static final String fr.dyade.aaa.util.Strings.toString ( Object  obj  )  [static]

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

Parameters:
obj the object to print
Returns:
a string representation of the object

Definition at line 98 of file Strings.java.

References fr.dyade.aaa.util.Strings.toString().

Here is the call graph for this function:

static final void fr.dyade.aaa.util.Strings.toByteArray ( ByteArrayOutputStream  output,
String  str 
) [static]

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

Definition at line 123 of file Strings.java.

Referenced by fr.dyade.aaa.util.Strings.toString().

static final void fr.dyade.aaa.util.Strings.toString ( StringBuffer  output,
String  str 
) [static]

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

Definition at line 210 of file Strings.java.

References fr.dyade.aaa.util.Strings.toString().

Here is the call graph for this function:

static final String fr.dyade.aaa.util.Strings.toString ( String  str  )  [static]

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

Definition at line 230 of file Strings.java.

References fr.dyade.aaa.util.Strings.toByteArray().

Here is the call graph for this function:

static final void fr.dyade.aaa.util.Strings.toString ( StringBuffer  output,
Object  obj,
Class  type 
) [static]

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

Definition at line 269 of file Strings.java.

References fr.dyade.aaa.util.Strings.listBorder, fr.dyade.aaa.util.Strings.listMax, and fr.dyade.aaa.util.Strings.toString().

Here is the call graph for this function:

static final void fr.dyade.aaa.util.Strings.toStringArray ( StringBuffer  output,
Object  tab 
) [static]

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
type the type of the array components

Definition at line 331 of file Strings.java.

References fr.dyade.aaa.util.Strings.toString().

Here is the call graph for this function:

static final String fr.dyade.aaa.util.Strings.toStringArray ( Object  tab  )  [static]

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

Definition at line 353 of file Strings.java.

References fr.dyade.aaa.util.Strings.toString().

Here is the call graph for this function:

static final void fr.dyade.aaa.util.Strings.toString ( StringBuffer  output,
boolean[]  tab 
) [static]

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

Definition at line 373 of file Strings.java.

References fr.dyade.aaa.util.Strings.listBorder, and fr.dyade.aaa.util.Strings.listMax.

static final void fr.dyade.aaa.util.Strings.toString ( StringBuffer  output,
byte[]  tab 
) [static]

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

Definition at line 411 of file Strings.java.

References fr.dyade.aaa.util.Strings.listBorder, and fr.dyade.aaa.util.Strings.listMax.

static final void fr.dyade.aaa.util.Strings.toString ( StringBuffer  output,
char[]  tab 
) [static]

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

Definition at line 449 of file Strings.java.

References fr.dyade.aaa.util.Strings.listBorder, and fr.dyade.aaa.util.Strings.listMax.

static final void fr.dyade.aaa.util.Strings.toString ( StringBuffer  output,
short[]  tab 
) [static]

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

Definition at line 487 of file Strings.java.

References fr.dyade.aaa.util.Strings.listBorder, and fr.dyade.aaa.util.Strings.listMax.

static final void fr.dyade.aaa.util.Strings.toString ( StringBuffer  output,
int[]  tab 
) [static]

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

Definition at line 525 of file Strings.java.

References fr.dyade.aaa.util.Strings.listBorder, and fr.dyade.aaa.util.Strings.listMax.

static final void fr.dyade.aaa.util.Strings.toString ( StringBuffer  output,
long[]  tab 
) [static]

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

Definition at line 563 of file Strings.java.

References fr.dyade.aaa.util.Strings.listBorder, and fr.dyade.aaa.util.Strings.listMax.

static final void fr.dyade.aaa.util.Strings.toString ( StringBuffer  output,
float[]  tab 
) [static]

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

Definition at line 601 of file Strings.java.

References fr.dyade.aaa.util.Strings.listBorder, and fr.dyade.aaa.util.Strings.listMax.

static final void fr.dyade.aaa.util.Strings.toString ( StringBuffer  output,
double[]  tab 
) [static]

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

Definition at line 639 of file Strings.java.

References fr.dyade.aaa.util.Strings.listBorder, and fr.dyade.aaa.util.Strings.listMax.

static final void fr.dyade.aaa.util.Strings.toString ( StringBuffer  output,
List  list 
) [static]

Provides a string representation of a list of objects. This includes Vectors. Uses the listMax and listBorder variables.

Parameters:
output a buffer to print the object into
list the list of Object objects to print

Definition at line 678 of file Strings.java.

References fr.dyade.aaa.util.Strings.listBorder, fr.dyade.aaa.util.Strings.listMax, and fr.dyade.aaa.util.Strings.toString().

Here is the call graph for this function:

static final String fr.dyade.aaa.util.Strings.toString ( List  list  )  [static]

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

Parameters:
list the list of Object objects to print
Returns:
a string representation of the list

Definition at line 716 of file Strings.java.

References fr.dyade.aaa.util.Strings.toString().

Here is the call graph for this function:

static final void fr.dyade.aaa.util.Strings.toString ( StringBuffer  output,
Collection  set 
) [static]

Provides a string representation of an unordered Collection of objects. This includes HashSets. Uses the listMax and listBorder variables.

Parameters:
output a buffer to print the object into
set the collection to print

Definition at line 733 of file Strings.java.

References fr.dyade.aaa.util.Strings.listBorder, fr.dyade.aaa.util.Strings.listMax, and fr.dyade.aaa.util.Strings.toString().

Here is the call graph for this function:

static final String fr.dyade.aaa.util.Strings.toString ( Collection  set  )  [static]

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

Parameters:
list the collection to print
Returns:
a string representation of the list

Definition at line 758 of file Strings.java.

References fr.dyade.aaa.util.Strings.toString().

Here is the call graph for this function:

static final void fr.dyade.aaa.util.Strings.toString ( StringBuffer  output,
Map  map 
) [static]

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

Definition at line 775 of file Strings.java.

References fr.dyade.aaa.util.Strings.toString().

Here is the call graph for this function:

static final String fr.dyade.aaa.util.Strings.toString ( Map  map  )  [static]

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

Parameters:
map the map to print
Returns:
a string representation of the map

Definition at line 791 of file Strings.java.

References fr.dyade.aaa.util.Strings.toString().

Here is the call graph for this function:

static final void fr.dyade.aaa.util.Strings.toString ( StringBuffer  output,
Map.Entry  entry 
) [static]

Provides a string representation of a Map entry.

Parameters:
output a buffer to print the object into
entry the map entry to print

Definition at line 806 of file Strings.java.

Member Data Documentation

int fr.dyade.aaa.util.Strings.listMax = 10 [static]

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.

Definition at line 248 of file Strings.java.

Referenced by fr.dyade.aaa.util.Strings.toString().

int fr.dyade.aaa.util.Strings.listBorder = 3 [static]

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.

Definition at line 259 of file Strings.java.

Referenced by fr.dyade.aaa.util.Strings.toString().

The documentation for this class was generated from the following file:
Generated on Tue Sep 16 16:17:25 2008 for joram by  doxygen 1.5.0