Interface HstComponentsConfiguration
public interface HstComponentsConfiguration
A
HstComponentConfigurations
contains a map of (root) HstComponentConfiguration
objects
which themselves might contain additional HstComponentConfiguration
children and so on. Each root
HstComponentConfiguration
is identified by a unique id within the HstComponentConfiguration
's
object.
NOTE: As HstComponent
instances can access HstComponentConfigurations
instances but should not
be able to modify them, implementations must make sure that through the api a HstComponentConfigurations
instance cannot be changed. Returned List and Map should be therefor unmodifiable.-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptiondefault Stream<HstComponentConfiguration>
flattened
(List<HstComponentConfiguration> childComponents) Returns all the availableHstComponentConfiguration
's belonging to theHstSite
Return the map of all *non prototype* canonicalHstComponentConfiguration
's where the keys are the theHstComponentConfiguration
's (HstComponentInfo.getId()
).
-
Field Details
-
NOOP
-
-
Method Details
-
getComponentConfigurations
Map<String,HstComponentConfiguration> getComponentConfigurations()Return the map of all *non prototype* canonical
HstComponentConfiguration
's where the keys are the theHstComponentConfiguration
's (HstComponentInfo.getId()
). Implementations should return an unmodifiable map to avoid client code changing configurationWith canonical we mean the
HstComponentConfiguration
's that are explicitly configured in the hst configuration and not a result of inheritance -
getComponentConfiguration
Returns the canonical
HstComponentConfiguration
whoseHstComponentInfo.getId()
equals thisid
.With canonical we mean the
HstComponentConfiguration
's that are explicitly configured in the hst configuration and not a result of inheritance- Parameters:
id
- the id of the canonicalHstComponentConfiguration
- Returns:
- a canonical
HstComponentConfiguration
whoseHstComponentInfo.getId()
equals thisid
. When there is noHstComponentConfiguration
with thisid
,null
is returned.
-
getAvailableContainerItems
List<HstComponentConfiguration> getAvailableContainerItems()Returns all the availableHstComponentConfiguration
's belonging to theHstSite
Implementations should return an unmodifiable List- Returns:
- the
List
of all available container items
-
getPrototypePages
Map<String,HstComponentConfiguration> getPrototypePages()- Returns:
- the map of
HstComponentConfiguration
s that are page prototypes . Unmodifiable instance will be returned. Empty map will be returned if no prototypes available
-
getXPages
Map<String,HstComponentConfiguration> getXPages()- Returns:
- the map of
HstComponentConfiguration
s that are xpage layouts where the keys are the names of the XPage node names (since XPages are only allowed below a single hst configuration node without inheriting from parent configurations, the node name is unique within aHstComponentsConfiguration
). Unmodifiable instance will be returned. Empty map will be returned if no xpages are available
-
flattened
default Stream<HstComponentConfiguration> flattened(List<HstComponentConfiguration> childComponents) - Returns:
- a depth-first stream of all
childComponents
plus their descendants
-