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.

Method Summary

Methods

Modifier and Type	Method and Description
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 root HstComponentConfiguration whose HstComponentInfo.getId() equals this id.
Map<String,HstComponentConfiguration>	getComponentConfigurations() Return the map of all root HstComponentConfiguration's where the keys are the the HstComponentConfiguration's (HstComponentInfo.getId()).

Method Detail

getComponentConfigurations

Map<String,HstComponentConfiguration> getComponentConfigurations()

Return the map of all root HstComponentConfiguration's where the keys are the the HstComponentConfiguration's (HstComponentInfo.getId()). Implementations should return an unmodifiable map, for example Collections.UnmodifiableMap to avoid client code changing configuration

Returns:

the map of all root HstComponentConfiguration's and an empty map if not root HstComponentConfiguration's are present. The keys in the map are the id's of the HstComponentConfiguration's (HstComponentInfo.getId())

getComponentConfiguration

HstComponentConfiguration getComponentConfiguration(String id)

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

Parameters:

id - the id of the root HstComponentConfiguration

Returns:

a root 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