ImmutablePropertiesImpl (Bracket Properties 1.3.6 API)

java.lang.Object
- asia.redact.bracket.properties.PropertiesBaseImpl
- - asia.redact.bracket.properties.ImmutablePropertiesImpl

All Implemented Interfaces:

Properties, Serializable
```
public class ImmutablePropertiesImpl
extends PropertiesBaseImpl
implements Properties
```
true immutable properties

Author:

Dave

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface asia.redact.bracket.properties.Properties
  Properties.Factory, Properties.Mode

Field Summary

Fields
Modifier and Type Field and Description

protected Entry[] array

private static long serialVersionUID
- Fields inherited from class asia.redact.bracket.properties.PropertiesBaseImpl
  antStyleVarPattern, dotIdentifierPattern, dotIntegerPattern, dotKeyValuePattern, lock, REF_TOKEN

Fields
Modifier and Type	Field and Description
`protected Entry[]`	`array`
`private static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description

ImmutablePropertiesImpl()

ImmutablePropertiesImpl(ArrayList<Entry> list)

ImmutablePropertiesImpl(Entry[] list)

Constructors
Constructor and Description
`ImmutablePropertiesImpl()`
`ImmutablePropertiesImpl(ArrayList<Entry> list)`
`ImmutablePropertiesImpl(Entry[] list)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Entry`	`atIndex(int index)`
`Object`	`beanValue(Class<?> clazz, String keyBase)` Serialize an arbitrary object
`BigDecimal`	`bigDecimalValue(String key)` Serialized bigDecimal support
`BigInteger`	`bigValue(String key)` serialized BigInteger support
`BitSet`	`bitsetValue(String key)` Return the value as a BitSet.
`boolean`	`booleanValue(String key)` Works for "true/false", "enabled/disabled", "yes/no"
`void`	`clear()` remove all entries from the underlying map
`boolean`	`containsKey(String key)` get(key) will throw a RuntimeException if the key does not exist.
`Properties`	`convertToLegacyProperties()` Get java.util.Properties from ours
`Date`	`dateValue(String key)` The value is assumed to be a long integer
`Date`	`dateValue(String key, String format)` I should really deprecate this - you should really use long values as dates in a serialization.
`void`	`delete(String key)`
`void`	`deobfuscate(String key)` Obverse of the above
`char[]`	`deobfuscateToChar(String key)`
`Entry`	`find(String key)` Given a key, locate our Entry in the array.
`float`	`floatValue(String key)`
`String`	`get(String key)` Get the value.
`List<String>`	`getComments(String key)` Get the list of comments, return an empty list if none
`Map<String,String>`	`getFlattenedMap()` Just return Strings as the values
`Properties`	`getGroup(GroupParams params)`
`List<String>`	`getList(String keyBase)` Given a base like key, collect keys like key.0, key.1, key.2 etc into a list.
`List<String>`	`getListKeys(String keyBase)` Return keys which match the pattern keyBase.0, keyBase.1, keyBase.2, etc.
`List<String>`	`getMapKeys(String keyBase)` Specialty method used with a map that has been serialized in the form keyBase dot integer dot k\|v For example, 0.0.k=a key 0.0.v=a value
`Map<String,ValueModel>`	`getPropertyMap()` for compatibility with PropertiesImpl code
`char`	`getSeparator(String key)` The char found in the parse, normally '='
`Node`	`getTree()` Get the properties as a tree of nodes.
`Node`	`getTree(GroupParams params)` Get the properties as a tree of nodes with a selector a.b.c=something a.b.c.d=something else a.b.c.e.f=item a.b.c.e=item2
`boolean`	`hasKeyLike(String partial)` Like containsKey but matching on the partial
`boolean`	`hasValue(String key)` Returns true if the key exists and has a non-empty value
`int`	`intValue(String key)` Coerce the value to an integer.
`List<String>`	`listValue(String key)` Where the value is a string you wish to tokenize, space delimiter
`List<String>`	`listValue(String key, String delimiter)` Where the value is a string you wish to tokenize, any delimiter
`long`	`longValue(String key)` Coerce to a long value.
`Properties`	`merge(Properties props)` Overwrite existing keys with the new ones, keep those existing ones that don't collide This operation is non-destructive on the input does not concatenate comments
`Properties`	`merge(Properties props, boolean mergeComments)` Overwrite existing keys with the new ones, keep those existing ones that don't collide This operation is non-destructive on the input
`Properties`	`merge(Properties props, boolean mergeComments, boolean deobfuscate)`
`void`	`mergeIntoSystemProperties()` Caution
`void`	`obfuscate(String key)` Obfuscate the value so it is more difficult to read.
`void`	`put(Entry entry)`
`void`	`put(String key, BigDecimal bd)`
`void`	`put(String key, BigInteger bi)`
`void`	`put(String key, boolean val)`
`void`	`put(String key, char val)`
`void`	`put(String key, char separator, Comment comment, String... values)`
`void`	`put(String key, Comment comment, String... values)`
`void`	`put(String key, double val)`
`void`	`put(String key, float val)`
`void`	`put(String key, int val)`
`void`	`put(String key, List<String> list)` companion of the above.
`void`	`put(String key, long val)`
`void`	`put(String key, String... values)` Add the key and value or values.
`void`	`putList(List<String> list, Comment comment, String rootKey)`
`void`	`putList(List<String> list, String rootKey)` create property keys and values based on a root key and a list in the form: rootKey.0= list.get(0); rootKey.1= list.get(1); and so on.
`String`	`resolve(String key)` Special method which resolves environment variables in the value.
`int`	`size()` Number of entries in the underlying map
`Properties`	`slice(String root)` Return a Properties object with only the set of keys which match the root.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - array
```
protected final Entry[] array
```
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ImmutablePropertiesImpl
```
public ImmutablePropertiesImpl(ArrayList<Entry> list)
```
  - ImmutablePropertiesImpl
```
public ImmutablePropertiesImpl(Entry[] list)
```
  - ImmutablePropertiesImpl
```
public ImmutablePropertiesImpl()
```
- Method Detail
  - getPropertyMap
```
public Map<String,ValueModel> getPropertyMap()
```
    for compatibility with PropertiesImpl code
    
    Specified by:
    
    getPropertyMap in interface Properties
    
    Returns:
  - getFlattenedMap
```
public Map<String,String> getFlattenedMap()
```
    Description copied from interface: Properties
    
    Just return Strings as the values
    
    Specified by:
    
    getFlattenedMap in interface Properties
    
    Returns:
  - find
```
public Entry find(String key)
```
    Given a key, locate our Entry in the array. This is thread-safe
    
    Parameters:
    
    key -
    
    Returns:
  - get
```
public String get(String key)
```
    Description copied from interface: Properties
    
    Get the value.
    
    Specified by:
    
    get in interface Properties
    
    Returns:
  - resolve
```
public String resolve(String key)
```
    Special method which resolves environment variables in the value. The variables take the form ${varname} like in ant. Variables in keys are not allowed
    
    Specified by:
    
    resolve in interface Properties
    
    Returns:
  - intValue
```
public int intValue(String key)
```
    Description copied from interface: Properties
    
    Coerce the value to an integer. Obviously this works better if the value is actually an integer.
    
    Specified by:
    
    intValue in interface Properties
    
    Returns:
  - booleanValue
```
public boolean booleanValue(String key)
```
    Works for "true/false", "enabled/disabled", "yes/no"
    
    Specified by:
    
    booleanValue in interface Properties
  - longValue
```
public long longValue(String key)
```
    Description copied from interface: Properties
    
    Coerce to a long value. Obviously this works better if the value is actually a long.
    
    Specified by:
    
    longValue in interface Properties
    
    Returns:
  - dateValue
```
public Date dateValue(String key)
```
    The value is assumed to be a long integer
    
    Specified by:
    
    dateValue in interface Properties
    
    Returns:
  - dateValue
```
public Date dateValue(String key,
                      String format)
               throws ParseException
```
    I should really deprecate this - you should really use long values as dates in a serialization. See above.
    
    Specified by:
    
    dateValue in interface Properties
    
    Returns:
    
    Throws:
    
    ParseException
  - listValue
```
public List<String> listValue(String key)
```
    Where the value is a string you wish to tokenize, space delimiter
    
    Specified by:
    
    listValue in interface Properties
    
    Returns:
  - listValue
```
public List<String> listValue(String key,
                              String delimiter)
```
    Where the value is a string you wish to tokenize, any delimiter
    
    Specified by:
    
    listValue in interface Properties
    
    Returns:
  - bitsetValue
```
public BitSet bitsetValue(String key)
```
    Description copied from interface: Properties
    
    Return the value as a BitSet. Obviously works better if the value is zeros and ones
    
    Specified by:
    
    bitsetValue in interface Properties
    
    Returns:
  - bigValue
```
public BigInteger bigValue(String key)
```
    Description copied from interface: Properties
    
    serialized BigInteger support
    
    Specified by:
    
    bigValue in interface Properties
    
    Returns:
  - bigDecimalValue
```
public BigDecimal bigDecimalValue(String key)
```
    Description copied from interface: Properties
    
    Serialized bigDecimal support
    
    Specified by:
    
    bigDecimalValue in interface Properties
    
    Returns:
  - beanValue
```
public Object beanValue(Class<?> clazz,
                        String keyBase)
```
    Description copied from interface: Properties
    
    Serialize an arbitrary object
    
    Specified by:
    
    beanValue in interface Properties
    
    Returns:
  - getTree
```
public Node getTree()
```
    Description copied from interface: Properties
```
Get the properties as a tree of nodes. For example,
 
 a.b.c=something
 a.b.c.d=something else
 
 looks like
 
 a
   b
     c - something
       d - something else
       
  This method is identical in results to getTree(regex) where the regex
  is "\\.". That is, the separator token in the key is a full stop
  
  Obviously this works better if your keys are delimited by dot characters
  
```
    Specified by:
    
    getTree in interface Properties
    
    Returns:
  - getTree
```
public Node getTree(GroupParams params)
```
    Description copied from interface: Properties
```
 Get the properties as a tree of nodes with a selector
 
 a.b.c=something
 a.b.c.d=something else
 a.b.c.e.f=item
 a.b.c.e=item2
 
```
    Specified by:
    
    getTree in interface Properties
  - getGroup
```
public Properties getGroup(GroupParams params)
```
  - getComments
```
public List<String> getComments(String key)
```
    Description copied from interface: Properties
    
    Get the list of comments, return an empty list if none
    
    Specified by:
    
    getComments in interface Properties
    
    Returns:
  - getSeparator
```
public char getSeparator(String key)
```
    Description copied from interface: Properties
    
    The char found in the parse, normally '='
    
    Specified by:
    
    getSeparator in interface Properties
    
    Returns:
  - size
```
public int size()
```
    Description copied from interface: Properties
    
    Number of entries in the underlying map
    
    Specified by:
    
    size in interface Properties
    
    Returns:
  - containsKey
```
public boolean containsKey(String key)
```
    Description copied from interface: Properties
```
 get(key) will throw a RuntimeException if the key does not
 exist. This method can be used to test for a key prior to
 calling get(). 
 
 Returns true if the underlying map has this key
 
 
```
    Specified by:
    
    containsKey in interface Properties
    
    Returns:
  - hasValue
```
public boolean hasValue(String key)
```
    Description copied from interface: Properties
    
    Returns true if the key exists and has a non-empty value
    
    Specified by:
    
    hasValue in interface Properties
    
    Returns:
  - mergeIntoSystemProperties
```
public void mergeIntoSystemProperties()
```
    Caution
    
    Specified by:
    
    mergeIntoSystemProperties in interface Properties
  - getList
```
public List<String> getList(String keyBase)
```
    Given a base like key, collect keys like key.0, key.1, key.2 etc into a list. The keys need not be in order in the file
    
    Specified by:
    
    getList in interface Properties
    
    Returns:
  - getListKeys
```
public List<String> getListKeys(String keyBase)
```
    Description copied from interface: Properties
    
    Return keys which match the pattern keyBase.0, keyBase.1, keyBase.2, etc. The list returned is in natural sorted order.
    
    Specified by:
    
    getListKeys in interface Properties
    
    Returns:
  - getMapKeys
```
public List<String> getMapKeys(String keyBase)
```
    Description copied from interface: Properties
    
    Specialty method used with a map that has been serialized in the form keyBase dot integer dot k|v For example, 0.0.k=a key 0.0.v=a value
    
    Specified by:
    
    getMapKeys in interface Properties
  - hasKeyLike
```
public boolean hasKeyLike(String partial)
```
    Description copied from interface: Properties
    
    Like containsKey but matching on the partial
    
    Specified by:
    
    hasKeyLike in interface Properties
    
    Returns:
  - convertToLegacyProperties
```
public Properties convertToLegacyProperties()
```
    Description copied from interface: Properties
    
    Get java.util.Properties from ours
    
    Specified by:
    
    convertToLegacyProperties in interface Properties
    
    Returns:
  - atIndex
```
public Entry atIndex(int index)
```
  - put
```
public void put(String key,
                List<String> list)
```
    Description copied from interface: Properties
    
    companion of the above. Given a list flatten it to a set of items as a value
    
    Specified by:
    
    put in interface Properties
  - put
```
public void put(Entry entry)
```
    Specified by:
    
    put in interface Properties
  - put
```
public void put(String key,
                String... values)
```
    Description copied from interface: Properties
    
    Add the key and value or values. Useful with multi-line entries
    
    Specified by:
    
    put in interface Properties
  - put
```
public void put(String key,
                int val)
```
    Specified by:
    
    put in interface Properties
  - put
```
public void put(String key,
                float val)
```
    Specified by:
    
    put in interface Properties
  - put
```
public void put(String key,
                double val)
```
    Specified by:
    
    put in interface Properties
  - put
```
public void put(String key,
                boolean val)
```
    Specified by:
    
    put in interface Properties
  - put
```
public void put(String key,
                char val)
```
    Specified by:
    
    put in interface Properties
  - put
```
public void put(String key,
                BigInteger bi)
```
    Specified by:
    
    put in interface Properties
  - put
```
public void put(String key,
                BigDecimal bd)
```
    Specified by:
    
    put in interface Properties
  - put
```
public void put(String key,
                Comment comment,
                String... values)
```
    Specified by:
    
    put in interface Properties
  - put
```
public void put(String key,
                char separator,
                Comment comment,
                String... values)
```
    Specified by:
    
    put in interface Properties
  - clear
```
public void clear()
```
    Description copied from interface: Properties
    
    remove all entries from the underlying map
    
    Specified by:
    
    clear in interface Properties
  - merge
```
public Properties merge(Properties props)
```
    Description copied from interface: Properties
    
    Overwrite existing keys with the new ones, keep those existing ones that don't collide This operation is non-destructive on the input does not concatenate comments
    
    Specified by:
    
    merge in interface Properties
    
    Returns:
    
    the merged properties
  - merge
```
public Properties merge(Properties props,
                        boolean mergeComments)
```
    Description copied from interface: Properties
    
    Overwrite existing keys with the new ones, keep those existing ones that don't collide This operation is non-destructive on the input
    
    Specified by:
    
    merge in interface Properties
    
    Returns:
    
    the merged properties
  - merge
```
public Properties merge(Properties props,
                        boolean mergeComments,
                        boolean deobfuscate)
```
    Specified by:
    
    merge in interface Properties
  - obfuscate
```
public void obfuscate(String key)
```
    Description copied from interface: Properties
    
    Obfuscate the value so it is more difficult to read. First call "put(key,value)" then "obfuscate(key)"
    
    Specified by:
    
    obfuscate in interface Properties
  - deobfuscate
```
public void deobfuscate(String key)
```
    Description copied from interface: Properties
    
    Obverse of the above
    
    Specified by:
    
    deobfuscate in interface Properties
  - deobfuscateToChar
```
public char[] deobfuscateToChar(String key)
```
    Specified by:
    
    deobfuscateToChar in interface Properties
  - putList
```
public void putList(List<String> list,
                    String rootKey)
```
    Description copied from interface: Properties
```
 create property keys and values based on a root key and a list in the form:
 
 rootKey.0= list.get(0);
 rootKey.1= list.get(1);
 
 and so on. This method is a complement to using getList(rootKey).
 
 
```
    Specified by:
    
    putList in interface Properties
  - putList
```
public void putList(List<String> list,
                    Comment comment,
                    String rootKey)
```
    Specified by:
    
    putList in interface Properties
  - delete
```
public void delete(String key)
```
    Specified by:
    
    delete in interface Properties
  - floatValue
```
public float floatValue(String key)
```
    Specified by:
    
    floatValue in interface Properties
  - put
```
public void put(String key,
                long val)
```
    Specified by:
    
    put in interface Properties
  - slice
```
public Properties slice(String root)
```
    Description copied from interface: Properties
    
    Return a Properties object with only the set of keys which match the root.
    
    Specified by:
    
    slice in interface Properties

Class ImmutablePropertiesImpl

Nested Class Summary

Nested classes/interfaces inherited from interface asia.redact.bracket.properties.Properties

Field Summary

Fields inherited from class asia.redact.bracket.properties.PropertiesBaseImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

array

serialVersionUID

Constructor Detail

ImmutablePropertiesImpl

ImmutablePropertiesImpl

ImmutablePropertiesImpl

Method Detail

getPropertyMap

getFlattenedMap

find

get

resolve

intValue

booleanValue

longValue

dateValue

dateValue

listValue

listValue

bitsetValue

bigValue

bigDecimalValue

beanValue

getTree

getTree

getGroup

getComments

getSeparator

size

containsKey

hasValue

mergeIntoSystemProperties

getList

getListKeys

getMapKeys

hasKeyLike

convertToLegacyProperties

atIndex

put

put

put

put

put

put

put

put

put

put

put

put

clear

merge

merge

merge

obfuscate

deobfuscate

deobfuscateToChar

putList

putList

delete

floatValue

put

slice