org.hippoecm.hst.core.request
Interface SiteMapItemHandlerConfiguration

All Known Implementing Classes:

SiteMapItemHandlerConfigurationImpl

public interface SiteMapItemHandlerConfiguration

A SiteMapItemHandlerConfiguration is the runtime instance of a HstSiteMapItemHandlerConfiguration and provides some configuration information to a sitemap item handler.

Method Summary

<T> Map<String,T>	getProperties(ResolvedSiteMapItem resolvedSiteMapItem, Class<T> mappingClass) Returns all resolved properties of type mappingClass into a map.
<T> T	getProperty(String name, ResolvedSiteMapItem resolvedSiteMapItem, Class<T> mappingClass)
<T> Map<String,T>	getRawProperties(Class<T> mappingClass) Returns the map of all unresolved properties of type T into a map and an empty map if there are no properties of type mappingClass
<T> T	getRawProperty(String name, Class<T> mappingClass) Returns the unresolved property for name or null when not present or is not of type mappingClass

Method Detail

getProperty

<T> T getProperty(String name,
                  ResolvedSiteMapItem resolvedSiteMapItem,
                  Class<T> mappingClass)

Type Parameters:

T -

Parameters:

name -

resolvedSiteMapItem -

mappingClass - the class the property value should be of

Returns:

the property if it is of type mappingClass. If the value is a String or String[] and contains a property placeholder it is resolved with the help of the ResolvedSiteMapItem. If there is a property placeholder that cannot be resolved, null will be returned in case for a String and in case of a String[] the value of the item in the array will be null

getProperties

<T> Map<String,T> getProperties(ResolvedSiteMapItem resolvedSiteMapItem,
                                Class<T> mappingClass)

Returns all resolved properties of type mappingClass into a map. If the property is of type String and contains a property placeholder, this property placeholder is replaced with it's value. If it cannot be resolved, the property won't be in the map. If the property is of type String[], all properties having a property placeholder are resolved. If a property placeholder cannot be resolved, that item in the array will be null

Type Parameters:

T -

Parameters:

hstResolvedSiteMapItem -

mappingClass - the class the property values should be of

Returns:

Returns the map of all resolved properties of type T into a map and an empty map if there are no properties of type T or there are only properties with unresolvable placeholders

getRawProperty

<T> T getRawProperty(String name,
                     Class<T> mappingClass)

Returns the unresolved property for name or null when not present or is not of type mappingClass

Type Parameters:

T -

Parameters:

name -

mappingClass - the class the property value should be of

Returns:

Returns the unresolved property for name or null when not present or not of type mappingClass

getRawProperties

<T> Map<String,T> getRawProperties(Class<T> mappingClass)

Returns the map of all unresolved properties of type T into a map and an empty map if there are no properties of type mappingClass

Type Parameters:

T -

Parameters:

mappingClass - the class the property values should be of

Returns:

Returns the map of all unresolved properties of type T into a map and an empty map if there are no properties of type mappingClass