Package org.apache.sling.caconfig
Interface ConfigurationBuilder
-
@ProviderType public interface ConfigurationBuilder
Defines how the configuration should be mapped and returned.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description <T> T
as(@NotNull java.lang.Class<T> clazz)
Get configuration as singleton resource and its properties mapped to the given annotation class.<T> T
asAdaptable(@NotNull java.lang.Class<T> clazz)
Get configuration as singleton configuration resource and adapt it to the given class.<T> @NotNull java.util.Collection<T>
asAdaptableCollection(@NotNull java.lang.Class<T> clazz)
Get collection of configuration resources and adapt them to the given class.<T> @NotNull java.util.Collection<T>
asCollection(@NotNull java.lang.Class<T> clazz)
Get collection of configuration resources with their properties mapped to the given annotation class.@NotNull ValueMap
asValueMap()
Get configuration as singleton resource and return its properties as value map.@NotNull java.util.Collection<ValueMap>
asValueMapCollection()
Get collection of configuration resources with their properties mapped to the given annotation class.<T> boolean
has(@NotNull java.lang.Class<T> clazz)
This method checks for the configuration existence based onconfigName
defined in the configuration definition.boolean
has(@NotNull java.lang.String configName)
This method checks for the configuration existence based on providedconfigName
value.@NotNull ConfigurationBuilder
name(@NotNull java.lang.String configName)
Define configuration name.
-
-
-
Method Detail
-
name
@NotNull @NotNull ConfigurationBuilder name(@NotNull @NotNull java.lang.String configName)
Define configuration name. Optional for theas(Class)
,asCollection(Class)
andhas(Class)
methods, mandatory for the others.- Parameters:
configName
- Relative path- Returns:
- Configuration builder
-
as
@NotNull <T> T as(@NotNull @NotNull 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 vianame(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
@NotNull <T> @NotNull java.util.Collection<T> asCollection(@NotNull @NotNull 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 vianame(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
@NotNull @NotNull ValueMap asValueMap()
Get configuration as singleton resource and return its properties as value map.- Returns:
- Value map. If content resource or configuration cannot be found the map is empty unless default or configuration override values are present for this configuration.
-
asValueMapCollection
@NotNull @NotNull java.util.Collection<ValueMap> asValueMapCollection()
Get collection of configuration resources with their properties mapped to the given annotation class.- Returns:
- Collection of value maps. Is empty if content resource or configuration cannot be found.
-
asAdaptable
<T> T asAdaptable(@NotNull @NotNull 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 aResource
- Returns:
- Object instance or null if content resource or configuration cannot be found or if the adaption was not possible.
-
asAdaptableCollection
@NotNull <T> @NotNull java.util.Collection<T> asAdaptableCollection(@NotNull @NotNull 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 aResource
- Returns:
- Collection of object instances. Is empty if content resource or configuration cannot be found or if the adaption was not possible.
-
has
<T> boolean has(@NotNull @NotNull java.lang.Class<T> clazz)
This method checks for the configuration existence based onconfigName
defined in the configuration definition. It extracts theconfigName
from the given annotation class and checks if the configuration is available for the context path in the current resource hierarchy. If not found, also checks in the global fall-back paths configured viaorg.apache.sling.caconfig.resource.impl.def.DefaultConfigurationResourceResolvingStrategy
which by default are/conf/global
,/apps/config
and/libs/config
.This method does not consider the default values provided in the configuration definition.- Type Parameters:
T
- Annotation class type- Parameters:
clazz
- Class that can be adapted from aResource
- Returns:
- True/False based on configuration resource node existence.
-
has
boolean has(@NotNull @NotNull java.lang.String configName)
This method checks for the configuration existence based on providedconfigName
value. It checks if the configuration is available for the context path in the current resource hierarchy and if not found, also checks in the global fall-back paths configured viaorg.apache.sling.caconfig.resource.impl.def.DefaultConfigurationResourceResolvingStrategy
which by default are/conf/global
,/apps/config
and/libs/config
. This method does not consider the default values provided in the configuration definition.- Parameters:
configName
- Name of the configuration- Returns:
- True/False based on configuration resource node existence.
-
-