org.pfsw.util

Class PropertiesMap

java.lang.Object

org.pfsw.util.PropertiesMap

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.String>, IConfigSettings, IReadOnlyNamedValues<java.lang.String>

public class PropertiesMap
extends java.lang.Object
implements java.util.Map<java.lang.String,java.lang.String>, IConfigSettings

A Map wrapper around a properties object that allows to treat the properties like a Map which is not possible with the original Properties because it is based on Hashtable.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
PropertiesMap()
PropertiesMap(java.util.Properties properties)

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>	entrySet()
java.lang.String	get(java.lang.Object key)
protected java.util.Properties	getInternalProperties()
java.util.Collection<java.lang.String>	getNames() Returns all names (maybe empty but never null).
java.util.Properties	getProperties() Returns the data as Properties object (a copy).
java.lang.String	getProperty(java.lang.String key) Searches for the property with the specified key in this property list.
java.lang.String	getProperty(java.lang.String key, java.lang.String defaultValue) Searches for the property with the specified key in this property list.
java.lang.String	getValue(java.lang.String name) Returns the value associated with the given name.
boolean	isEmpty() Returns true if the receiver does not contain any data.
java.util.Set<java.lang.String>	keySet()
java.lang.String	put(java.lang.String key, java.lang.String value)
void	putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> map)
java.lang.String	remove(java.lang.Object key)
void	setProperty(java.lang.String key, java.lang.String value) Sets the given value as ne property value for the given key.
int	size()
java.util.Set<java.lang.String>	stringPropertyNames() Returns a set of keys in this property list where the key and its corresponding value are strings, including distinct keys in the default property list if a key of the same name has not already been found from the main properties list.
java.util.Collection<java.lang.String>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

PropertiesMap

public PropertiesMap()

PropertiesMap

public PropertiesMap(java.util.Properties properties)

Method Detail

getProperties

public java.util.Properties getProperties()

Returns the data as Properties object (a copy). Modifying the returned properties does not have any impact on this object.

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.String,java.lang.String>

isEmpty

public boolean isEmpty()

Description copied from interface: IReadOnlyNamedValues

Returns true if the receiver does not contain any data.

Specified by:

isEmpty in interface java.util.Map<java.lang.String,java.lang.String>

Specified by:

isEmpty in interface IReadOnlyNamedValues<java.lang.String>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.lang.String>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.String,java.lang.String>

get

public java.lang.String get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.String>

put

public java.lang.String put(java.lang.String key,
                            java.lang.String value)

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.String>

remove

public java.lang.String remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.String,java.lang.String>

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> map)

Specified by:

putAll in interface java.util.Map<java.lang.String,java.lang.String>

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.String,java.lang.String>

keySet

public java.util.Set<java.lang.String> keySet()

Specified by:

keySet in interface java.util.Map<java.lang.String,java.lang.String>

values

public java.util.Collection<java.lang.String> values()

Specified by:

values in interface java.util.Map<java.lang.String,java.lang.String>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> entrySet()

Specified by:

entrySet in interface java.util.Map<java.lang.String,java.lang.String>

getProperty

public java.lang.String getProperty(java.lang.String key)

Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns null if the property is not found.

getProperty

public java.lang.String getProperty(java.lang.String key,
                                    java.lang.String defaultValue)

Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns the default value argument if the property is not found.

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

Sets the given value as ne property value for the given key.

stringPropertyNames

public java.util.Set<java.lang.String> stringPropertyNames()

Returns a set of keys in this property list where the key and its corresponding value are strings, including distinct keys in the default property list if a key of the same name has not already been found from the main properties list. Properties whose key or value is not of type String are omitted. The returned set is not backed by the Properties object. Changes to this Properties are not reflected in the set, or vice versa.

getNames

public java.util.Collection<java.lang.String> getNames()

Description copied from interface: IReadOnlyNamedValues

Returns all names (maybe empty but never null).

Specified by:

getNames in interface IReadOnlyNamedValues<java.lang.String>

getValue

public java.lang.String getValue(java.lang.String name)

Description copied from interface: IReadOnlyNamedValues

Returns the value associated with the given name.

Specified by:

getValue in interface IReadOnlyNamedValues<java.lang.String>

Parameters:

name - The identifier for which the associated value must be returned (must not be null).

Returns:

The values associated with the name or null if the name is unknown.

getInternalProperties

protected java.util.Properties getInternalProperties()