IMsPropertiesHandler (formcycle: bom 8.2.0 API)

All Superinterfaces:

IAPIHandler, Serializable

All Known Implementing Classes:

MsPropertiesHandler
```
public interface IMsPropertiesHandler
extends IAPIHandler
```
Common interface for the handler for accessing properties of the master server properties files.

Since:

8.0.0

Author:

XIMA Media GmbH

Method Summary

All Methods Instance Methods Abstract Methods
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 interface de.xima.fc.com.interfaces.IAPIHandler
getName

- Method Detail
  - getByKey
```
@Nullable
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. May be null.
    
    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
```
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.
    
    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
```
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.
    
    Parameters:
    
    fileName - of the properties file.
    
    keyPrefix - prefix of the property keys.
    
    Returns:
    
    A map with all matching properties values.