org.hippoecm.hst.configuration.components

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<'/code>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

Fields

Modifier and Type	Field and Description
static HstComponentsConfiguration	NOOP

Method Summary

Modifier and Type	Method and Description
default Stream<HstComponentConfiguration>	flattened(List<HstComponentConfiguration> childComponents)
List<HstComponentConfiguration>	getAvailableContainerItems() Returns all the available HstComponentConfiguration's belonging to the HstSite Implementations should return an unmodifiable List
HstComponentConfiguration	getComponentConfiguration(String id) Returns the canonical HstComponentConfiguration whose HstComponentInfo.getId() equals this id.
Map<String,HstComponentConfiguration>	getComponentConfigurations() Return the map of all *non prototype* canonical HstComponentConfiguration's where the keys are the the HstComponentConfiguration's (HstComponentInfo.getId()).
Map<String,HstComponentConfiguration>	getPrototypePages()
Map<String,HstComponentConfiguration>	getXPages()

Field Detail

NOOP

static final HstComponentsConfiguration NOOP

Method Detail

getComponentConfigurations

Map<String,HstComponentConfiguration> getComponentConfigurations()

Return the map of all *non prototype* canonical HstComponentConfiguration's where the keys are the the HstComponentConfiguration's (HstComponentInfo.getId()). Implementations should return an unmodifiable map to avoid client code changing configuration

With canonical we mean the HstComponentConfiguration's that are explicitly configured in the hst configuration and not a result of inheritance

getComponentConfiguration

HstComponentConfiguration getComponentConfiguration(String id)

Returns the canonical HstComponentConfiguration whose HstComponentInfo.getId() equals this id.

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 canonical HstComponentConfiguration

Returns:

a canonical HstComponentConfiguration whose HstComponentInfo.getId() equals this id. When there is no HstComponentConfiguration with this id, null is returned.

getAvailableContainerItems

List<HstComponentConfiguration> getAvailableContainerItems()

Returns all the available HstComponentConfiguration's belonging to the HstSite

Implementations should return an unmodifiable List

Returns:

the List of all available container items

getPrototypePages

Map<String,HstComponentConfiguration> getPrototypePages()

Returns:

the map of HstComponentConfigurations 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 HstComponentConfigurations 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 a HstComponentsConfiguration). 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