com.flexive.shared.configuration.parameters
Class ParameterFactory

java.lang.Object
  com.flexive.shared.configuration.parameters.ParameterFactory

public final class ParameterFactory
extends java.lang.Object

This factory beans provides methods for instantiating new parameter objects to be used with flexive's configuration API. To create a typesafe parameter definition, you must supply the parameter class (e.g. Long) and the attributes describing the parameter itself, such as the (global) path it's stored under and its scope (e.g. user- or division-scoped).

:

 // define a boolean parameter "booleanParam" for path "/configuration" with a default value of false
 Parameter<Boolean> bp = ParameterFactory.newInstance(Boolean.class, "/configuration", ParameterScope.USER, "booleanParam", false);

 // define a long parameter with a default value of 25
 Parameter<Long> lp = ParameterFactory.newInstance(Long.class, "/configuration", ParameterScope.USER, "longParam", 25L);

 // define an object parameter for QueryRootNode.class with no default value that works by serializing the objects via XStream
 Parameter<QueryRootNode> DEFAULT_QUERY = ParameterFactory.newInstance(QueryRootNode.class, "/configuration", ParameterScope.USER, "defaultQuery", null);
 

More examples can be found in SystemParameters.

Version:

$Rev: 632 $

Author:

Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)

Method Summary

static <T> Parameter<T>	newInstance(java.lang.Class<T> cls, ParameterData<T> data) Creates a new parameter from a ParameterData instance.
static <T> Parameter<T>	newInstance(java.lang.Class<T> cls, ParameterPath path, java.lang.String key, T defaultValue) Create a new parameter with key and default value, using path information from a ParameterPath object.
static <T> Parameter<T>	newInstance(java.lang.Class<T> cls, ParameterPath path, T defaultValue) Create a new parameter without a specific key and a default value.
static <T> Parameter<T>	newInstance(java.lang.Class<T> cls, java.lang.String path, ParameterScope scope, java.lang.String key, T defaultValue) Create a new parameter for a path with key and default value.
static <T> Parameter<T>	newInstance(java.lang.Class<T> cls, java.lang.String path, ParameterScope scope, T defaultValue) Create a new parameter for a path with a default value, but without a fixed key.

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static <T> Parameter<T> newInstance(java.lang.Class<T> cls,
                                           ParameterData<T> data)

Creates a new parameter from a ParameterData instance.

Parameters:

cls - the parameter type class

data - the bean holding all parameter properties

Returns:

a new parameter instance

newInstance

public static <T> Parameter<T> newInstance(java.lang.Class<T> cls,
                                           ParameterPath path,
                                           java.lang.String key,
                                           T defaultValue)

Create a new parameter with key and default value, using path information from a ParameterPath object.

Parameters:

cls - the parameter type class

path - the path description

key - the parameter key

defaultValue - the default value (if null, no default value will be used)

Returns:

a new parameter instance

newInstance

public static <T> Parameter<T> newInstance(java.lang.Class<T> cls,
                                           ParameterPath path,
                                           T defaultValue)

Create a new parameter without a specific key and a default value. The key has to be specified in configuration queries. This is useful for dynamic keys, e.g. for storing user preferences for different pages (using the page path for the key).

Parameters:

cls - the parameter type class

path - the path description

defaultValue - the default value (if null, no default value will be used)

Returns:

a new parameter instance

newInstance

public static <T> Parameter<T> newInstance(java.lang.Class<T> cls,
                                           java.lang.String path,
                                           ParameterScope scope,
                                           java.lang.String key,
                                           T defaultValue)

Create a new parameter for a path with key and default value.

Parameters:

cls - the parameter type class

path - the path description

scope - the parameter scope (user, division, or global)

key - the parameter key

defaultValue - the default value (if null, no default value will be used)

Returns:

a new parameter instance

newInstance

public static <T> Parameter<T> newInstance(java.lang.Class<T> cls,
                                           java.lang.String path,
                                           ParameterScope scope,
                                           T defaultValue)

Create a new parameter for a path with a default value, but without a fixed key. The key has to be specified in configuration queries. This is useful for dynamic keys, e.g. for storing user preferences for different pages (using the page path for the key).

Parameters:

cls - the parameter type class

path - the path description

scope - the parameter scope (user, division, or global)

defaultValue - the default value (if null, no default value will be used)

Returns:

a new parameter instance