org.ametys.runtime.parameter

Class ParameterHelper

java.lang.Object

org.ametys.runtime.parameter.ParameterHelper

public final class ParameterHelper
extends Object

This class handles all needed to use typed parameters

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParameterHelper.ParameterType Enumeration of supported types

Field Summary

Fields

Modifier and Type	Field and Description
private static DateTimeFormatter	__ISO_OFFSET_DATE_TIME The ISO date-time formatter that formats or parses a date-time with an offset, such as '2011-12-03T10:15:30.000+01:00'.
private static Logger	_logger

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ParameterHelper()

Method Summary

Modifier and Type	Method and Description
private static void	_saxConfigurationObject(ContentHandler handler, String name, Object value)
static Object	castValue(String value, ParameterHelper.ParameterType type) Cast a untyped value (string) to an object of the type
static DateTimeFormatter	getISODateTimeFormatter() Get the ISO date-time formatter that formats or parses a date-time with an offset, such as '2011-12-03T10:15:30.000+01:00'.
static ParameterHelper.ParameterType	stringToType(String type) Convert a string containing a type to its value
static Map<String,Object>	toJSON(Parameter parameter) Convert the parameter in a JSON map
static void	toSAXEnumerator(ContentHandler handler, Enumerator enumerator) SAX parameter enumerator
static void	toSAXParameter(ContentHandler handler, Parameter parameter, Object value) SAX a parameter
static void	toSAXParameterInternal(ContentHandler handler, Parameter parameter, Object value) SAX a parameter except the root tag
static void	toSAXValidator(ContentHandler handler, Validator validator) SAX parameter validator
static String	typeToString(ParameterHelper.ParameterType type) Return the readable name of a type
static String	valueToString(Object value) Converts known types to string

Methods inherited from class java.lang.Object

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

Field Detail

__ISO_OFFSET_DATE_TIME

private static DateTimeFormatter __ISO_OFFSET_DATE_TIME

The ISO date-time formatter that formats or parses a date-time with an offset, such as '2011-12-03T10:15:30.000+01:00'.

_logger

private static Logger _logger

Constructor Detail

ParameterHelper

private ParameterHelper()

Method Detail

getISODateTimeFormatter

public static DateTimeFormatter getISODateTimeFormatter()

Get the ISO date-time formatter that formats or parses a date-time with an offset, such as '2011-12-03T10:15:30.000+01:00'. This formatter is similar to DateTimeFormatter.ISO_OFFSET_DATE_TIME but force 3-digits milliseconds.

Returns:

ISO date-time formatter

typeToString

public static String typeToString(ParameterHelper.ParameterType type)

Return the readable name of a type

Parameters:

type - Type to convert

Returns:

Returns the name of the type

Throws:

IllegalArgumentException - If the type is unknwon

stringToType

public static ParameterHelper.ParameterType stringToType(String type)

Convert a string containing a type to its value

Parameters:

type - Name of the type

Returns:

Type

Throws:

IllegalArgumentException - if the type is unknown

castValue

public static Object castValue(String value,
                               ParameterHelper.ParameterType type)

Cast a untyped value (string) to an object of the type

Parameters:

value - Value to cast

type - Type to cast value in

Returns:

An object of the type 'type' with value 'value', or null if type is unknown or value cannot be cast

valueToString

public static String valueToString(Object value)

Converts known types to string

Parameters:

value - Typed value

Returns:

String readable by the config bean

Throws:

IllegalArgumentException - if the object is a InputStream

toSAXParameter

public static void toSAXParameter(ContentHandler handler,
                                  Parameter parameter,
                                  Object value)
                           throws SAXException,
                                  ProcessingException

SAX a parameter

Parameters:

handler - The content handler where to SAX

parameter - The parameter to SAX

value - The parameter value. Can be null.

Throws:

SAXException - If an error occurred while SAXing

ProcessingException - If an error occurred

toSAXParameterInternal

public static void toSAXParameterInternal(ContentHandler handler,
                                          Parameter parameter,
                                          Object value)
                                   throws SAXException,
                                          ProcessingException

SAX a parameter except the root tag

Parameters:

handler - The content handler where to SAX

parameter - The parameter to SAX

value - The parameter value. Can be null.

Throws:

SAXException - If an error occurred while SAXing

ProcessingException - If an error occurred

toSAXEnumerator

public static void toSAXEnumerator(ContentHandler handler,
                                   Enumerator enumerator)
                            throws SAXException,
                                   ProcessingException

SAX parameter enumerator

Parameters:

handler - The content handler where to SAX

enumerator - The enumerator to SAX

Throws:

SAXException - If an error occurred to SAX

ProcessingException - If an error occurred

toSAXValidator

public static void toSAXValidator(ContentHandler handler,
                                  Validator validator)
                           throws SAXException

SAX parameter validator

Parameters:

handler - The content handler where to SAX

validator - The validator to SAX

Throws:

SAXException - If an error occurred while SAXing

_saxConfigurationObject

private static void _saxConfigurationObject(ContentHandler handler,
                                            String name,
                                            Object value)
                                     throws SAXException

Throws:

SAXException

toJSON

public static Map<String,Object> toJSON(Parameter parameter)
                                 throws ProcessingException

Convert the parameter in a JSON map

Parameters:

parameter - The parameter to convert

Returns:

The Parameter as a map

Throws:

ProcessingException - If an error occured when converting the parameter