org.apache.sling.caconfig

Interface ConfigurationBuilder

@ProviderType
public interface ConfigurationBuilder

Defines how the configuration should be mapped and returned.

Method Summary

Modifier and Type	Method and Description
<T> T	as(Class<T> clazz) Get configuration as singleton resource and its properties mapped to the given annotation class.
<T> T	asAdaptable(Class<T> clazz) Get configuration as singleton configuration resource and adapt it to the given class.
<T> Collection<T>	asAdaptableCollection(Class<T> clazz) Get collection of configuration resources and adapt them to the given class.
<T> Collection<T>	asCollection(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.
Collection<ValueMap>	asValueMapCollection() Get collection of configuration resources with their properties mapped to the given annotation class.
ConfigurationBuilder	name(String configName) Define configuration name.

Method Detail

name

@Nonnull
ConfigurationBuilder name(@Nonnull
                                   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

@Nonnull
<T> T as(@Nonnull
                  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

@Nonnull
<T> Collection<T> asCollection(@Nonnull
                                        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

@Nonnull
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

@Nonnull
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(@Nonnull
                  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

@Nonnull
<T> Collection<T> asAdaptableCollection(@Nonnull
                                                 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.