PropertiesImpl (Bracket Properties 1.3.5 API)

java.lang.Object
- asia.redact.bracket.properties.AbstractPropertiesBase
- - asia.redact.bracket.properties.PropertiesImpl

All Implemented Interfaces:: Properties, Serializable

Direct Known Subclasses:: SortedPropertiesImpl

public class PropertiesImpl
extends AbstractPropertiesBase
implements Properties

 A better Properties class. This implementation class is thread-safe.

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 Pattern`	`dotIdentifierPattern`
`protected Pattern`	`dotIntegerPattern`
`protected Pattern`	`dotKeyValuePattern`
`protected static String`	`REF_TOKEN`
`private static long`	`serialVersionUID`

Fields inherited from class asia.redact.bracket.properties.AbstractPropertiesBase
contentType, lock, map

Constructor Summary

Constructors
Constructor and Description
`PropertiesImpl()`
`PropertiesImpl(InputStream in)`
`PropertiesImpl(InputStream in, Charset charset)`
`PropertiesImpl(Map map)`
`PropertiesImpl(Properties legacy)` TODO - implement compatibility mode Some slight information loss here is unavoidable.
`PropertiesImpl(Reader in)`
`PropertiesImpl(URL url)`

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`beanValue(Class<?> clazz, String keyBase)`
`BigDecimal`	`bigDecimalValue(String key)`
`BigInteger`	`bigValue(String key)`
`BitSet`	`bitsetValue(String key)`
`boolean`	`booleanValue(String key)`
`Properties`	`convertToLegacyProperties()` Get java.util.Properties from ours
`Date`	`dateValue(String key)` Date value here is assumed to be a long
`Date`	`dateValue(String key, String format)` I should really deprecate this - you should really use long values as dates in a serialization.
`boolean`	`equals(Object obj)`
`String`	`get(String key)` Get the value of the property; concatenate multiple lines.
`List<String>`	`getComments(String key)` Get the list of comments, return an empty list if none
`Map<String,String>`	`getFlattenedMap()` Just return Strings
`Properties`	`getGroup(GroupParams params)`
`List<String>`	`getKeyGroup(String keyBase)`
`String`	`getKeyRef(String key)`
`List<String>`	`getList(String keyBase)` This method relies on the convention of using numbers at the end of a property key to represent a list member.
`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
`List<String>`	`getMatchingKeys(String partial)` Return the keys which match the partial key submitted
`Map<String,ValueModel>`	`getPropertyMap()` Can be used to get direct access to the Entry data structures
`char`	`getSeparator(String key)` The char found in the parse, normally '='
`Node`	`getTree()` Use "\\." as the separator
`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
`int`	`hashCode()`
`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
`protected void`	`initMap()`
`int`	`intValue(String key)` Coerce to an integer value.
`List<String>`	`listValue(String key)`
`List<String>`	`listValue(String key, String delimiter)`
`long`	`longValue(String key)` Coerce to a long value.
`Properties`	`merge(Properties props)` This is a merge function, existing keys which do not collide with the incoming are kept, keys that collide are overwritten with the new values TODO, cause comments to come over as well
`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
`void`	`mergeIntoSystemProperties()` Not easily reversable, use with care
`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, char separator, 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> values)`
`void`	`put(String key, String... values)` Yes, multi-valued (multi-lined) properties are in the spec.
`void`	`putKeyRef(String newRefKey, String existingKey)`
`void`	`putList(List<String> list, char sep, Comment comment, String rootKey)`
`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.
`void`	`putList(String key, char ch, List<String> list)`
`void`	`synchronize(Node rootNode)` Cause a graph to become the contents of the properties file.

Methods inherited from class asia.redact.bracket.properties.AbstractPropertiesBase
clear, containsKey, containsValue, getContentType, isEmpty, keySet, remove, setContentType, size, toString, values

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

Methods inherited from interface asia.redact.bracket.properties.Properties
clear, containsKey, getContentType, setContentType, size

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    Constant Field Values
  - dotIntegerPattern
```
protected Pattern dotIntegerPattern
```
  - dotIdentifierPattern
```
protected Pattern dotIdentifierPattern
```
  - dotKeyValuePattern
```
protected Pattern dotKeyValuePattern
```
  - REF_TOKEN
```
protected static final String REF_TOKEN
```
    See Also:
    Constant Field Values
- Constructor Detail
  - PropertiesImpl
```
public PropertiesImpl()
```
  - PropertiesImpl
```
public PropertiesImpl(Properties legacy)
```
```
 TODO - implement compatibility mode
 
 Some slight information loss here is unavoidable. For example if a colon is used as the separator in the original,
 that information will be lost. If you need a more exact translation you can do that
 with the lexer and parser classes by reading in the data directly from the properties file instead
 of reading in with java.util.Properties and then converting.
 
 
```
  - PropertiesImpl
```
public PropertiesImpl(Map map)
```
  - PropertiesImpl
```
public PropertiesImpl(URL url)
```
  - PropertiesImpl
```
public PropertiesImpl(InputStream in)
```
  - PropertiesImpl
```
public PropertiesImpl(InputStream in,
              Charset charset)
```
  - PropertiesImpl
```
public PropertiesImpl(Reader in)
```
- Method Detail
  - initMap
```
protected void initMap()
```
  - get
```
public String get(String key)
```
    Get the value of the property; concatenate multiple lines.
    
    Specified by:
    
    get in interface Properties
    
    Parameters:
    key -
    
    Returns:
    
    Throws:
    
    RuntimeException - if key is not present.
  - getKeyRef
```
public String getKeyRef(String key)
```
  - putKeyRef
```
public void putKeyRef(String newRefKey,
             String existingKey)
```
  - put
```
public void put(String key,
       String... values)
```
    Yes, multi-valued (multi-lined) properties are in the spec. If the key already exists, all the values are removed and replaced
    
    Specified by:
    
    put in interface Properties
    
    Parameters:
    key -
    values -
  - put
```
public void put(String key,
       List<String> values)
```
    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,
       String... values)
```
  - put
```
public void put(String key,
       char separator,
       Comment comment,
       String... values)
```
    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,
       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,
       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
  - getPropertyMap
```
public Map<String,ValueModel> getPropertyMap()
```
    Description copied from interface: Properties
    
    Can be used to get direct access to the Entry data structures
    
    Specified by:
    
    getPropertyMap in interface Properties
    
    Returns:
  - getFlattenedMap
```
public Map<String,String> getFlattenedMap()
```
    Description copied from interface: Properties
    
    Just return Strings
    
    Specified by:
    
    getFlattenedMap in interface Properties
    
    Returns:
  - 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:
  - getKeyGroup
```
public List<String> getKeyGroup(String keyBase)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractPropertiesBase
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AbstractPropertiesBase
  - merge
```
public Properties merge(Properties props)
```
    This is a merge function, existing keys which do not collide with the incoming are kept, keys that collide are overwritten with the new values TODO, cause comments to come over as well
    
    Specified by:
    
    merge in interface Properties
    
    Parameters:
    props -
    
    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
  - getTree
```
public Node getTree()
```
    Use "\\." as the separator
    
    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)
```
  - getMatchingKeys
```
public List<String> getMatchingKeys(String partial)
```
    Return the keys which match the partial key submitted
    
    Parameters:
    partial -
    
    Returns:
  - 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:
  - intValue
```
public int intValue(String key)
```
    Description copied from interface: Properties
    
    Coerce to an integer value. Obviously this works better if the value is actually an integer.
    
    Specified by:
    
    intValue in interface Properties
    
    Returns:
  - booleanValue
```
public boolean booleanValue(String key)
```
    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)
```
    Description copied from interface: Properties
    
    Date value here is assumed to be a long
    
    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
  - 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:
  - synchronize
```
public void synchronize(Node rootNode)
```
    Description copied from interface: Properties
    
    Cause a graph to become the contents of the properties file. Destructive to current entries, so this is not very useful yet
    
    Specified by:
    
    synchronize in interface Properties
  - mergeIntoSystemProperties
```
public void mergeIntoSystemProperties()
```
    Not easily reversable, use with care
    
    Specified by:
    
    mergeIntoSystemProperties in interface Properties
  - 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
  - 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:
  - getList
```
public List<String> getList(String keyBase)
```
    Description copied from interface: Properties
```
 This method relies on the convention of using numbers at
 the end of a property key to represent a list member. The total 
 list is the set of all similar keys with key as the base
 and dot delimited integers at the end. Suppose the following 
 (from the Tanukisoft wrapper.conf):
 
 wrapper.java.classpath.1=../lib/wrapper.jar
 wrapper.java.classpath.2=../lib/myapp.jar
 wrapper.java.classpath.3=../lib/mysql.jar
 wrapper.java.classpath.4=../classes
 
 Then calling getList("wrapper.java.classpath") would
 return all the values above, in numeric order, as a List.
 
 If key does not exist but numbered properties exist, the
 key is synthesized. if no numbered properties exist, an
 empty list is returned. If the key does not exist and no numbered
 keys exist, the method returns an empty list
 
 Numbers need not be sequential
  
  
```
    Specified by:
    
    getList in interface Properties
    
    Returns:
  - listValue
```
public List<String> listValue(String key)
```
    Specified by:
    
    listValue in interface Properties
  - listValue
```
public List<String> listValue(String key,
                     String delimiter)
```
    Specified by:
    
    listValue in interface Properties
  - putList
```
public void putList(String key,
           char ch,
           List<String> list)
```
  - bitsetValue
```
public BitSet bitsetValue(String key)
```
    Specified by:
    
    bitsetValue in interface Properties
  - bigValue
```
public BigInteger bigValue(String key)
```
    Specified by:
    
    bigValue in interface Properties
  - bigDecimalValue
```
public BigDecimal bigDecimalValue(String key)
```
    Specified by:
    
    bigDecimalValue in interface Properties
  - beanValue
```
public Object beanValue(Class<?> clazz,
               String keyBase)
```
    Specified by:
    
    beanValue 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
  - putList
```
public void putList(List<String> list,
           char sep,
           Comment comment,
           String rootKey)
```
  - convertToLegacyProperties
```
public Properties convertToLegacyProperties()
```
    Description copied from interface: Properties
    
    Get java.util.Properties from ours
    
    Specified by:
    
    convertToLegacyProperties in interface Properties
    
    Returns:

Class PropertiesImpl

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class asia.redact.bracket.properties.AbstractPropertiesBase

Methods inherited from class java.lang.Object

Methods inherited from interface asia.redact.bracket.properties.Properties

Field Detail

serialVersionUID

dotIntegerPattern

dotIdentifierPattern

dotKeyValuePattern

REF_TOKEN

Constructor Detail

PropertiesImpl

PropertiesImpl

PropertiesImpl

PropertiesImpl

PropertiesImpl

PropertiesImpl

PropertiesImpl

Method Detail

initMap

get

getKeyRef

putKeyRef

put

put

put

put

put

put

put

put

put

put

put

put

getPropertyMap

getFlattenedMap

getComments

getSeparator

getKeyGroup

hashCode

equals

merge

merge

getTree

getTree

getGroup

getMatchingKeys

hasKeyLike

intValue

booleanValue

longValue

dateValue

dateValue

hasValue

synchronize

mergeIntoSystemProperties

getMapKeys

getListKeys

getList

listValue

listValue

putList

bitsetValue

bigValue

bigDecimalValue

beanValue

putList

putList

putList

convertToLegacyProperties