Package org.infinispan.commons.util

Class TypedProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<java.lang.Object,java.lang.Object>

java.util.Properties

org.infinispan.commons.util.TypedProperties

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public class TypedProperties
extends java.util.Properties

Type-aware properties. Extends the JDK Properties class to provide accessors that convert values to certain types, using default values if a conversion is not possible.

Since:

4.0

Author:

Manik Surtani

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TypedProperties()	Default constructor that returns an empty instance
TypedProperties(java.util.Properties p)	Copy constructor

Method Summary

Modifier and Type	Method	Description
boolean	getBooleanProperty(java.lang.String key, boolean defaultValue)
boolean	getBooleanProperty(java.lang.String key, boolean defaultValue, boolean doStringReplace)
<T extends java.lang.Enum<T>> T	getEnumProperty(java.lang.String key, java.lang.Class<T> enumClass, T defaultValue)
<T extends java.lang.Enum<T>> T	getEnumProperty(java.lang.String key, java.lang.Class<T> enumClass, T defaultValue, boolean doStringReplace)
int	getIntProperty(java.lang.String key, int defaultValue)
int	getIntProperty(java.lang.String key, int defaultValue, boolean doStringReplace)
long	getLongProperty(java.lang.String key, long defaultValue)
long	getLongProperty(java.lang.String key, long defaultValue, boolean doStringReplace)
java.lang.String	getProperty(java.lang.String key, java.lang.String defaultValue, boolean doStringReplace)	Get the property associated with the key, optionally applying string property replacement as defined in StringPropertyReplacer.replaceProperties(java.lang.String) to the result.
TypedProperties	putIfAbsent(java.lang.String key, java.lang.String value)	Put a value if the associated key is not present
TypedProperties	setProperty(java.lang.String key, boolean value)
TypedProperties	setProperty(java.lang.String key, int value)
TypedProperties	setProperty(java.lang.String key, long value)
TypedProperties	setProperty(java.lang.String key, java.lang.String value)
static TypedProperties	toTypedProperties(java.util.Properties p)	Factory method that converts a JDK Properties instance to an instance of TypedProperties, if needed.

Constructor Detail

TypedProperties

public TypedProperties(java.util.Properties p)

Copy constructor

Parameters:

p - properties instance to from. If null, then it is treated as an empty Properties instance.

TypedProperties

public TypedProperties()

Default constructor that returns an empty instance

Method Detail

toTypedProperties

public static TypedProperties toTypedProperties(java.util.Properties p)

Factory method that converts a JDK Properties instance to an instance of TypedProperties, if needed.

Parameters:

p - properties to convert.

Returns:

A TypedProperties object. Returns an empty TypedProperties instance if p is null.

getIntProperty

public int getIntProperty(java.lang.String key,
                          int defaultValue)

getIntProperty

public int getIntProperty(java.lang.String key,
                          int defaultValue,
                          boolean doStringReplace)

getLongProperty

public long getLongProperty(java.lang.String key,
                            long defaultValue)

getLongProperty

public long getLongProperty(java.lang.String key,
                            long defaultValue,
                            boolean doStringReplace)

getBooleanProperty

public boolean getBooleanProperty(java.lang.String key,
                                  boolean defaultValue)

getBooleanProperty

public boolean getBooleanProperty(java.lang.String key,
                                  boolean defaultValue,
                                  boolean doStringReplace)

getEnumProperty

public <T extends java.lang.Enum<T>> T getEnumProperty(java.lang.String key,
                                                       java.lang.Class<T> enumClass,
                                                       T defaultValue)

getEnumProperty

public <T extends java.lang.Enum<T>> T getEnumProperty(java.lang.String key,
                                                       java.lang.Class<T> enumClass,
                                                       T defaultValue,
                                                       boolean doStringReplace)

getProperty

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

Get the property associated with the key, optionally applying string property replacement as defined in StringPropertyReplacer.replaceProperties(java.lang.String) to the result.

Parameters:

key - the hashtable key.

defaultValue - a default value.

doStringReplace - boolean indicating whether to apply string property replacement

Returns:

the value in this property list with the specified key valu after optionally being inspected for String property replacement

putIfAbsent

public TypedProperties putIfAbsent(java.lang.String key,
                                   java.lang.String value)

Put a value if the associated key is not present

Parameters:

key - new key

value - new value

Returns:

this TypedProperties instance for method chaining

setProperty

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

setProperty

public TypedProperties setProperty(java.lang.String key,
                                   int value)

setProperty

public TypedProperties setProperty(java.lang.String key,
                                   long value)

setProperty

public TypedProperties setProperty(java.lang.String key,
                                   boolean value)