JProperties (JCMS API)

java.lang.Object
- java.util.Dictionary<K,V>
- - java.util.Hashtable<K,V>
  - - com.jalios.util.JProperties

All Implemented Interfaces:

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

Direct Known Subclasses:

LangProperties
```
public class JProperties
extends java.util.Hashtable<K,V>
```
This class, based on Properties manage properties file in UTF-8 encoding. Its save updateAndSave(File) methods keep layout of previous properties file.

Version:

$Revision: 58058 $

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Set<JPropertiesListener>`	`listenerSet`
`protected static int`	`PREFIX_PROPERTIES_CACHE_MAX_ENTRIES`
`protected java.util.Map<java.lang.String,JProperties>`	`prefixPropertiesCache`
`protected boolean`	`propertyNameAsDefaultValue`
`static java.lang.String`	`REVISION`

Constructor Summary

Constructors
Constructor and Description

JProperties()

Constructors
Constructor and Description
`JProperties()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addProperties(JProperties prop)` Add every property of the given `JProperties` to this `JProperties`.
`void`	`addProperties(java.util.Properties prop)` Add every property of the given `Properties` to this `JProperties`.
`void`	`addPropertiesListener(JPropertiesListener l)` Adds a listener for any change of this JProperties.
`protected static java.lang.String[]`	`buildArrayFromString(java.lang.String value, java.lang.String[] defaultValue)` Convert a string to a String[] using the following formats: "@value1value2
`protected JProperties`	`checkCacheGetProperties(java.lang.String prefix)`
`void`	`clearProperties()` Clear all properties.
`boolean`	`containsProperty(java.lang.String name)` Tests if this JProperties contains the given property key/name.
`void`	`firePropertiesChange()` Triggers a propertie change to notify all listener of this JProperties.
`boolean`	`getBooleanProperty(java.lang.String name, boolean defaultValue)` Gets the value of a property as a boolean given its key/name.
`double`	`getDoubleProperty(java.lang.String name, double defaultValue)` Gets the value of a property as a double value given its key/name.
`float`	`getFloatProperty(java.lang.String name, float defaultValue)` Gets the value of a property as a float value given its key/name.
`int[]`	`getIntArrayProperty(java.lang.String name, int[] defaultValue)` Gets the value of a property as a int array.
`int`	`getIntegerProperty(java.lang.String name, int defaultValue)` Gets the value of a property as an int value given its key/name.
`protected java.util.Set<JPropertiesListener>`	`getListenerSet()` Retrieve set of all listeners for this JProperties.
`long`	`getLongProperty(java.lang.String name, long defaultValue)` Gets the value of a property as a long value given its key/name.
`JProperties`	`getProperties(java.lang.String prefix)` Returns a new property set of properties with key matching a given prefix.
`java.lang.String`	`getProperty(java.lang.String name)` Gets value of a property.
`java.lang.String`	`getProperty(java.lang.String name, java.lang.String defaultValue)` Gets the value of a property given its key/name.
`java.lang.String[]`	`getStringArrayProperty(java.lang.String name, java.lang.String[] defaultValue)` Gets the value of a property as a String array.
`java.util.Map<java.lang.String,java.lang.Object>`	`getSubProperties(java.lang.String prefix)` Returns a map of properties built from those properties and having a given prefix.
`void`	`invalidateCacheGetProperties()` Invalidate the cache used for `getProperties(String)` method.
`void`	`load(java.io.File file)` Reads a property file (key and element pairs) from the given File.
`void`	`load(java.io.File file, java.lang.String prefix)` Reads a property file (key and element pairs) from the given File.
`V`	`put(K key, V value)`
`protected void`	`putCacheGetProperties(java.lang.String prefix, JProperties prop)`
`void`	`removePropertiesListener(JPropertiesListener l)` Removes a listener for any change of this JProperties.
`java.lang.Object`	`setProperty(java.lang.String name, java.lang.String value)` Sets value of a property.
`void`	`updateAndSave(java.io.File file)` Updates and save properties.

Methods inherited from class java.util.Hashtable
clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - REVISION
```
public static final java.lang.String REVISION
```
    See Also:
    Constant Field Values
  - PREFIX_PROPERTIES_CACHE_MAX_ENTRIES
```
protected static final int PREFIX_PROPERTIES_CACHE_MAX_ENTRIES
```
    See Also:
    Constant Field Values
  - prefixPropertiesCache
```
protected java.util.Map<java.lang.String,JProperties> prefixPropertiesCache
```
  - propertyNameAsDefaultValue
```
protected boolean propertyNameAsDefaultValue
```
  - listenerSet
```
protected java.util.Set<JPropertiesListener> listenerSet
```
- Constructor Detail
  - JProperties
```
public JProperties()
```
- Method Detail
  - getListenerSet
```
protected java.util.Set<JPropertiesListener> getListenerSet()
```
    Retrieve set of all listeners for this JProperties.
    
    Returns:
    the set of all listeners for this JProperties.
    See Also:
    addPropertiesListener(JPropertiesListener), removePropertiesListener(JPropertiesListener)
  - addPropertiesListener
```
public void addPropertiesListener(JPropertiesListener l)
```
    Adds a listener for any change of this JProperties.
    
    Parameters:
    l - the listener to add
    See Also:
    removePropertiesListener(JPropertiesListener)
  - removePropertiesListener
```
public void removePropertiesListener(JPropertiesListener l)
```
    Removes a listener for any change of this JProperties.
    
    Parameters:
    l - the listener to remove
    See Also:
    addPropertiesListener(JPropertiesListener)
  - firePropertiesChange
```
public void firePropertiesChange()
```
    Triggers a propertie change to notify all listener of this JProperties.
    
    See Also:
    addPropertiesListener(JPropertiesListener)
  - containsProperty
```
public boolean containsProperty(java.lang.String name)
```
    Tests if this JProperties contains the given property key/name.
    
    Parameters:
    name - the key/name of the property to check
    
    Returns:
    true if the specified object is a key in this hashtable; false otherwise.
  - getProperty
```
public java.lang.String getProperty(java.lang.String name)
```
    Gets value of a property.
    
    Parameters:
    name - the key/name of the property to retrieve
    
    Returns:
    the property value
  - getProperty
```
public java.lang.String getProperty(java.lang.String name,
                           java.lang.String defaultValue)
```
    Gets the value of a property given its key/name.
    
    Parameters:
    name - the key/name of the property to retrieve
    defaultValue - the default value to use if the existing value is null.
    
    Returns:
    the value of a property given its key/name.
  - setProperty
```
public java.lang.Object setProperty(java.lang.String name,
                           java.lang.String value)
```
    Sets value of a property.
    
    Parameters:
    name - the key/name of the property to retrieve
    value - the new value to assign.
    
    Returns:
    the previous value of the specified key/name
  - getBooleanProperty
```
public boolean getBooleanProperty(java.lang.String name,
                         boolean defaultValue)
```
    Gets the value of a property as a boolean given its key/name.
    
    Parameters:
    name - the key/name of the property to retrieve
    defaultValue - the default value to use if the existing value is null or is neither "false" nor "true" (case sensitive).
    
    Returns:
    the boolean value of the property
  - getIntegerProperty
```
public int getIntegerProperty(java.lang.String name,
                     int defaultValue)
```
    Gets the value of a property as an int value given its key/name.
    
    Parameters:
    name - the key/name of the property to retrieve
    defaultValue - the default value to use if the existing value is null or if Integer.parseInt() throws exception during String to int conversion.
    
    Returns:
    the int value of the property
  - getLongProperty
```
public long getLongProperty(java.lang.String name,
                   long defaultValue)
```
    Gets the value of a property as a long value given its key/name.
    
    Parameters:
    name - the key/name of the property to retrieve
    defaultValue - the default value to use if the existing value is null or if Long.parseLong() throws exception during String to long conversion.
    
    Returns:
    the long value of the property
  - getFloatProperty
```
public float getFloatProperty(java.lang.String name,
                     float defaultValue)
```
    Gets the value of a property as a float value given its key/name.
    
    Parameters:
    name - the key/name of the property to retrieve
    defaultValue - the default value to use if the existing value is null or if Float.parseFloat() throws exception during String to float conversion.
    
    Returns:
    the float value of the property
  - getDoubleProperty
```
public double getDoubleProperty(java.lang.String name,
                       double defaultValue)
```
    Gets the value of a property as a double value given its key/name.
    
    Parameters:
    name - the key/name of the property to retrieve
    defaultValue - the default value to use if the existing value is null or if Double.parseDouble() throws exception during String to double conversion.
    
    Returns:
    the double value of the property
  - getStringArrayProperty
```
public java.lang.String[] getStringArrayProperty(java.lang.String name,
                                        java.lang.String[] defaultValue)
```
    Gets the value of a property as a String array.
    The property value should be in one of the following forms:
  - "@value1value2...", where delim is a one character delimiter.
  - "value1value2...", where delim is a character from " \t\n\r\f".

Parameters:: name - the key/name of the property to retrieve; defaultValue - the default value to use if the existing value is null or no values could be found in the conversion.
Returns:: a String array

buildArrayFromString

protected static java.lang.String[] buildArrayFromString(java.lang.String value,
                                      java.lang.String[] defaultValue)

Convert a string to a String[] using the following formats:

"@value1value2...", where delim is a one character delimiter.
"value1value2...", where delim is a character from " \t\n\r\f".

Class JProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.Hashtable

Methods inherited from class java.lang.Object

Field Detail

REVISION

PREFIX_PROPERTIES_CACHE_MAX_ENTRIES

prefixPropertiesCache

propertyNameAsDefaultValue

listenerSet

Constructor Detail

JProperties

Method Detail

getListenerSet

addPropertiesListener

removePropertiesListener

firePropertiesChange

containsProperty

getProperty

getProperty

setProperty

getBooleanProperty

getIntegerProperty

getLongProperty

getFloatProperty

getDoubleProperty

getStringArrayProperty

buildArrayFromString

getIntArrayProperty

addProperties

addProperties

checkCacheGetProperties

putCacheGetProperties

invalidateCacheGetProperties

getProperties

getSubProperties

clearProperties

load

load

updateAndSave

put