org.xins.common
Class FormattedParameters

java.lang.Object
  extended byorg.xins.common.FormattedParameters

public class FormattedParameters
extends Object

Convert parameters to (semi) human readable text.

Since:
XINS 2.0
Version:
$Revision: 1.1 $ $Date: 2007/05/29 12:22:30 $
Author:
Ernst de Haan, Anthony Goubard

Constructor Summary
FormattedParameters(PropertyReader parameters)
          Constructs a new FormattedParameters object.
FormattedParameters(PropertyReader parameters, Element dataSection)
          Constructs a new FormattedParameters object.
FormattedParameters(PropertyReader parameters, Element dataSection, String valueIfEmpty, String prefixIfNotEmpty, int maxValueLength)
          Constructs a new FormattedParameters object.
 
Method Summary
 String toString()
          String representation of the parameters including the data section.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FormattedParameters

public FormattedParameters(PropertyReader parameters)
Constructs a new FormattedParameters object.

Parameters:
parameters - the parameters, can be null.

FormattedParameters

public FormattedParameters(PropertyReader parameters,
                           Element dataSection)
Constructs a new FormattedParameters object.

Parameters:
parameters - the parameters, can be null.
dataSection - the data section, can be null.

FormattedParameters

public FormattedParameters(PropertyReader parameters,
                           Element dataSection,
                           String valueIfEmpty,
                           String prefixIfNotEmpty,
                           int maxValueLength)
Constructs a new FormattedParameters object.

Parameters:
parameters - the parameters, can be null.
dataSection - the data section, can be null.
valueIfEmpty - the value to return if there is no parameter and no data section, can be null.
prefixIfNotEmpty - the prefix to add if there is a parameter or a data section, can be null.
maxValueLength - the maximum of characters to set for the value, if the value is longer than this limit '...' will be added after the limit. If the value is -1, no limit will be set.
Method Detail

toString

public String toString()
String representation of the parameters including the data section.

Returns:
the String representation of the request.


See http://www.xins.org/.