Package de.xima.fc.handler.system

Class MsPropertiesHandler

java.lang.Object

de.xima.fc.handler.AMSApiHandler

de.xima.fc.handler.system.MsPropertiesHandler

All Implemented Interfaces:

IAPIHandler, IMsPropertiesHandler, Serializable

public class MsPropertiesHandler
extends AMSApiHandler
implements IMsPropertiesHandler

Default implementation of the IMsPropertiesHandler interface.

Since:

8.0.0

Author:

XIMA Media GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MsPropertiesHandler()

Method Summary

Modifier and Type	Method	Description
Object	getByKey(String fileName, String key)	Gets the value of the property with the given key in the properties file with the given file name.
Map<String,Object>	getByKeyPrefix(String fileName, String keyPrefix)	Gets all the properties that have keys that start with the given prefix from the properties file with the given file name.
Map<String,Object>	getByKeys(String fileName, Set<String> keys)	Gets all the properties that have keys that are contained within the given key set from the properties file with the given file name.

Methods inherited from class de.xima.fc.handler.AMSApiHandler

getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler

getName

Constructor Detail

MsPropertiesHandler

public MsPropertiesHandler()

Method Detail

getByKey

public Object getByKey(String fileName,
                       String key)

Description copied from interface: IMsPropertiesHandler

Gets the value of the property with the given key in the properties file with the given file name. May be null.

Specified by:

getByKey in interface IMsPropertiesHandler

Parameters:

fileName - of the properties file.

key - of the property within the properties file.

Returns:

The property value if it has been set, or null otherwise.

getByKeys

public Map<String,Object> getByKeys(String fileName,
                                          Set<String> keys)

Description copied from interface: IMsPropertiesHandler

Gets all the properties that have keys that are contained within the given key set from the properties file with the given file name.

Specified by:

getByKeys in interface IMsPropertiesHandler

Parameters:

fileName - of the properties file.

keys - Set of all the property keys.

Returns:

A map with all properties values. Each property value may be empty if it has not been set.

getByKeyPrefix

public Map<String,Object> getByKeyPrefix(String fileName,
                                               String keyPrefix)

Description copied from interface: IMsPropertiesHandler

Gets all the properties that have keys that start with the given prefix from the properties file with the given file name.

Specified by:

getByKeyPrefix in interface IMsPropertiesHandler

Parameters:

fileName - of the properties file.

keyPrefix - prefix of the property keys.

Returns:

A map with all matching properties values.