Package org.onehippo.forge.properties.impl

Class AbstractPropertiesManager

java.lang.Object

org.onehippo.forge.properties.impl.AbstractPropertiesManager

All Implemented Interfaces:

PropertiesManager

Direct Known Subclasses:

PropertiesManagerImpl

public abstract class AbstractPropertiesManager
extends Object
implements PropertiesManager

PropertiesManager implementing mainly the getPropertiesBean methods without Locale argument and deprecated methods.

Constructor Summary

Constructors

Constructor	Description
AbstractPropertiesManager()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getProperties(String[] paths, org.hippoecm.hst.content.beans.standard.HippoBean baseBean)	Returns a map with String name/value pairs.
Map<String,String>	getProperties(org.hippoecm.hst.content.beans.standard.HippoBean baseBean)	Returns a map with String name/value pairs.
PropertiesBean	getPropertiesBean(String path, org.hippoecm.hst.content.beans.standard.HippoBean baseBean)	Get the bean representing the properties document with the given name at the configured location, relative to the given base bean (if configured location does not start with slash).
PropertiesBean	getPropertiesBean(org.hippoecm.hst.content.beans.standard.HippoBean baseBean)	Get the bean representing the properties document with the configured default name at the configured location, relative to the given base bean (if configured location does not start with slash).
List<PropertiesBean>	getPropertiesBeans(List<String> paths, org.hippoecm.hst.content.beans.standard.HippoBean baseBean)	Get the beans representing the properties documents with the given names at the configured location, relative to the given base bean (if configured location does not start with slash).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.onehippo.forge.properties.api.PropertiesManager

getDefaultDocumentLocation, getDefaultDocumentName, getPropertiesBean, getPropertiesBean, getPropertiesBeans, invalidate

Constructor Details

AbstractPropertiesManager

public AbstractPropertiesManager()

Method Details

getPropertiesBean

public PropertiesBean getPropertiesBean(org.hippoecm.hst.content.beans.standard.HippoBean baseBean)

Get the bean representing the properties document with the configured default name at the configured location, relative to the given base bean (if configured location does not start with slash).

Specified by:

getPropertiesBean in interface PropertiesManager

Parameters:

baseBean - the base bean from where to get the properties location (if location does not start with slash), normally the siteContentBaseBean.

getPropertiesBean

public PropertiesBean getPropertiesBean(String path,
 org.hippoecm.hst.content.beans.standard.HippoBean baseBean)

Get the bean representing the properties document with the given name at the configured location, relative to the given base bean (if configured location does not start with slash).

Specified by:

getPropertiesBean in interface PropertiesManager

Parameters:

path - the relative paths of the properties documents to search for

baseBean - the base bean from where to get the properties location (if location does not start with slash), normally the siteContentBaseBean.

getPropertiesBeans

public List<PropertiesBean> getPropertiesBeans(List<String> paths,
 org.hippoecm.hst.content.beans.standard.HippoBean baseBean)

Get the beans representing the properties documents with the given names at the configured location, relative to the given base bean (if configured location does not start with slash).

Specified by:

getPropertiesBeans in interface PropertiesManager

Parameters:

paths - the relative paths of the properties documents to search for

baseBean - the base bean from where to get the properties location, normally the siteContentBaseBean.

getProperties

public Map<String,String> getProperties(org.hippoecm.hst.content.beans.standard.HippoBean baseBean)

Returns a map with String name/value pairs. Get the properties from the document with the default name at the default location.

Specified by:

getProperties in interface PropertiesManager

Parameters:

baseBean - the base bean from where to get the properties location, normally the siteContentBaseBean.

getProperties

public Map<String,String> getProperties(String[] paths,
 org.hippoecm.hst.content.beans.standard.HippoBean baseBean)

Returns a map with String name/value pairs. Get the properties from the documents with the given names at the default location. If multiple documents are found they are merged into one map.

Specified by:

getProperties in interface PropertiesManager

Parameters:

paths - the relative paths of the properties documents to search for

baseBean - the base bean from where to get the properties location, normally the siteContentBaseBean.