com.adobe.aem.dermis.api.bridge

Class DataContext

java.lang.Object

com.adobe.aem.dermis.api.bridge.DataContext

All Implemented Interfaces:

Map<String,Object>

public class DataContext
extends Object
implements Map<String,Object>

The DataContext represents a pluggable mechanism for resolving a operation arguments at evaluation time. DataContext use HashMap and expression (Operation argument expression) is used has key. get(Object) Resolve the specified argument expression, and return the corresponding object, if any; otherwise, return null. For example operation argument contains expression like user.profile.id or ${user.profile.id} and data context provide will used to retrieve the value user.profile.id

Constructor Summary

Constructors

Constructor and Description
DataContext()
DataContext(Map<String,Object> base)

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
void	deRegister() Remove all registered Converters, and re-establish the standard Converters.
void	deRegister(Class clazz) Remove any registered Converter for the specified destination Class.
Set<Map.Entry<String,Object>>	entrySet()
Object	get(Object key)
<T> T	get(String name, Class<T> type) Get a named property and convert it into the given type.
<T> T	get(String name, Class<T> type, T defaultValue) Get a named property and convert it into the given type.
<T> T	get(String name, T defaultValue) Get a named property and convert it into the given type.
boolean	isEmpty()
Set<String>	keySet()
Object	put(String key, Object value)
void	putAll(Map<? extends String,?> map)
void	register(boolean throwException, boolean defaultNull, int defaultArraySize) Register the provided converters with the specified defaults.
void	register(org.apache.commons.beanutils.Converter converter, Class<?> clazz) Register a custom Converter for the specified destination Class, replacing any previously registered Converter.
Object	remove(Object key)
int	size()
Collection<Object>	values()

Constructor Detail

DataContext

public DataContext()

DataContext

public DataContext(Map<String,Object> base)

Method Detail

deRegister

public void deRegister()

Remove all registered Converters, and re-establish the standard Converters.

deRegister

public void deRegister(Class clazz)

Remove any registered Converter for the specified destination Class.

Parameters:

clazz - - Class for which to remove a registered Converter

register

public void register(boolean throwException,
                     boolean defaultNull,
                     int defaultArraySize)

Register the provided converters with the specified defaults.

Parameters:

throwException - - true if the converters should throw an exception when a conversion error occurs, otherwise false if a default value should be used.

defaultNull - - true if the standard converters (see ConvertUtilsBean.registerStandard(boolean, boolean) should use a default value of null, otherwise false. N.B. This values is ignored if throwException is true

defaultArraySize - - The size of the default array value for array converters (N.B. This values is ignored if throwException is true). Specifying a value less than zero causes a null value to be used for the default.

register

public void register(org.apache.commons.beanutils.Converter converter,
                     Class<?> clazz)

Register a custom Converter for the specified destination Class, replacing any previously registered Converter.

Parameters:

converter - - Converter to be registered

clazz - - Destination class for conversions performed by this Converter

get

public <T> T get(String name,
                 Class<T> type,
                 T defaultValue)

Get a named property and convert it into the given type.

Parameters:

name - The name of the property

type - The class of the type

defaultValue - The default value to use if the named property does not exist or cannot be converted to the requested type. The default value is also used to define the type to convert the value to. If this is null any existing property is not converted.

Returns:

Return named value converted to type T or null if non existing or can't be converted.

get

public <T> T get(String name,
                 Class<T> type)

Get a named property and convert it into the given type.

Parameters:

name - The name of the property

type - The class of the type

Returns:

Return named value converted to type T or null if non existing or can't be converted.

get

public <T> T get(String name,
                 T defaultValue)

Get a named property and convert it into the given type. It should return the default value if value empty

Parameters:

name - The name of the property

defaultValue - The default value to use if the named property does not exist or cannot be converted to the requested type. The default value is also used to define the type to convert the value to. If this is null any existing property is not converted.

Returns:

Return named value converted to type T or the default value if non existing or can't be converted.

size

public int size()

isEmpty

public boolean isEmpty()

containsKey

public boolean containsKey(Object key)

containsValue

public boolean containsValue(Object value)

get

public Object get(Object key)

put

public Object put(String key,
                  Object value)

remove

public Object remove(Object key)

putAll

public void putAll(Map<? extends String,?> map)

clear

public void clear()

keySet

public Set<String> keySet()

values

public Collection<Object> values()

entrySet

public Set<Map.Entry<String,Object>> entrySet()