org.apache.sling.caconfig

Interface ConfigurationBuilder

public interface ConfigurationBuilder

Defines how the configuration should be mapped and returned.

Method Summary

Modifier and Type	Method and Description
<T> T	as(java.lang.Class<T> clazz) Get configuration as singleton resource and its properties mapped to the given annotation class.
<T> T	asAdaptable(java.lang.Class<T> clazz) Get configuration as singleton configuration resource and adapt it to the given class.
<T> java.util.Collection<T>	asAdaptableCollection(java.lang.Class<T> clazz) Get collection of configuration resources and adapt them to the given class.
<T> java.util.Collection<T>	asCollection(java.lang.Class<T> clazz) Get collection of configuration resources with their properties mapped to the given annotation class.
ValueMap	asValueMap() Get configuration as singleton resource and return its properties as value map.
java.util.Collection<ValueMap>	asValueMapCollection() Get collection of configuration resources with their properties mapped to the given annotation class.
ConfigurationBuilder	name(java.lang.String configName) Define configuration name.

Method Detail

name

ConfigurationBuilder name(java.lang.String configName)

Define configuration name. Optional for the as(Class) and asCollection(Class) methods, mandatory for the others.

Parameters:

configName - Relative path

Returns:

Configuration builder

as

<T> T as(java.lang.Class<T> clazz)

Get configuration as singleton resource and its properties mapped to the given annotation class. Configuration name is optional - if not given via name(String) method it is derived from the annotation interface class name.

Type Parameters:

T - Annotation class type

Parameters:

clazz - Annotation interface class

Returns:

Configuration object. Contains only the default values if content resource or configuration cannot be found.

asCollection

<T> java.util.Collection<T> asCollection(java.lang.Class<T> clazz)

Get collection of configuration resources with their properties mapped to the given annotation class. Configuration name is optional - if not given via name(String) method it is derived from the annotation interface class name.

Type Parameters:

T - Annotation class type

Parameters:

clazz - Annotation interface class

Returns:

Collection of configuration objects. Is empty if content resource or configuration cannot be found.

asValueMap

ValueMap asValueMap()

Get configuration as singleton resource and return its properties as value map.

Returns:

Value map. Map is empty if content resource or configuration cannot be found.

asValueMapCollection

java.util.Collection<ValueMap> asValueMapCollection()

Get collection of configuration resources with their properties mapped to the given annotation class.

Returns:

Collection of value map. Is empty if content resource or configuration cannot be found.

asAdaptable

<T> T asAdaptable(java.lang.Class<T> clazz)

Get configuration as singleton configuration resource and adapt it to the given class.

Type Parameters:

T - Annotation class type

Parameters:

clazz - Class that can be adapted from a Resource

Returns:

Object instance or null if content resource or configuration cannot be found or if the adaption was not possible.

asAdaptableCollection

<T> java.util.Collection<T> asAdaptableCollection(java.lang.Class<T> clazz)

Get collection of configuration resources and adapt them to the given class.

Type Parameters:

T - Annotation class type

Parameters:

clazz - Class that can be adapted from a Resource

Returns:

Collection of object instances. Is empty if content resource or configuration cannot be found or if the adaption was not possible.