org.xins.common

Class FormattedParameters

java.lang.Object

org.xins.common.FormattedParameters

public class FormattedParameters
extends Object

Convert parameters to (semi) human readable text.

Since:

XINS 2.0

Version:

$Revision: 1.7 $ $Date: 2010/11/18 20:35:05 $

Author:

Ernst de Haan, Anthony Goubard

Constructor Summary

Constructors

Constructor and Description
FormattedParameters(Map<String,String> parameters) Constructs a new FormattedParameters object.
FormattedParameters(Map<String,String> parameters, Element dataSection) Constructs a new FormattedParameters object.
FormattedParameters(Map<String,String> parameters, Element dataSection, String valueIfEmpty, String prefixIfNotEmpty, int maxValueLength) Constructs a new FormattedParameters object.

Method Summary

Methods

Modifier and Type	Method and Description
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(Map<String,String> parameters)

Constructs a new FormattedParameters object.

Parameters:

parameters - the parameters, can be null.

FormattedParameters

public FormattedParameters(Map<String,String> 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(Map<String,String> 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.

Overrides:

toString in class Object

Returns:

the String representation of the request.