PropertyStore (Apache Juneau 7.1.1)

java.lang.Object
- org.apache.juneau.PropertyStore

```
public final class PropertyStore
extends Object
```
Represents an immutable collection of properties.
The general idea behind a property store is to serve as a reusable configuration of an artifact (e.g. a Serializer) such that the artifact can be cached and reused if the property stores are 'equal'.
Concept

For example, two serializers of the same type created with the same configuration will always end up being the same serializer:
WriterSerializer s1 = JsonSerializer.create().pojoSwaps(MySwap.class).simple().build(); WriterSerializer s2 = JsonSerializer.create().simple().pojoSwaps(MySwap.class).build(); assert(s1 == s2);

This has the effect of significantly improving performance, especially if you're creating many Serializers and Parsers.
PropertyStoreBuilder

The PropertyStoreBuilder class is used to build up and instantiate immutable PropertyStore objects.
In the example above, the property store being built looks like the following:
PropertyStore ps = PropertyStore .create() .set("BeanContext.pojoSwaps.lc", MySwap.class) .set("JsonSerializer.simpleMode.b", true) .build();

Property stores are immutable, comparable, and their hashcodes are calculated exactly one time. That makes them particularly suited for use as hashmap keys, and thus for caching reusable serializers and parsers.
Property naming convention

Property names must have the following format...
"{class}.{name}.{type}"

...where the parts consist of the following...
- "{class}" - The group name of the property (e.g. "JsonSerializer").
  It's always going to be the simple class name of the class it's associated with.
- "{name}" - The property name (e.g. "useWhitespace").
- "{type}" - The property data type.
  A 1 or 2 character string that identifies the data type of the property.
  Valid values are:
  - "s": String
  - "b": Boolean
  - "i": Integer
  - "c": Class
  - "o": Object
  - "ss": TreeSet<String>
  - "si": TreeSet<Integer>
  - "sc": TreeSet<Class>
  - "ls": Linkedlist<String>
  - "li": Linkedlist<Integer>
  - "lc": Linkedlist<Class>
  - "lo": Linkedlist<Object>
  - "sms": TreeMap<String,String>
  - "smi": TreeMap<String,Integer>
  - "smc": TreeMap<String,Class>
  - "smo": TreeMap<String,Object>
  - "oms": LinkedHashMap<String,String>
  - "omi": LinkedHashMap<String,Integer>
  - "omc": LinkedHashMap<String,Class>
  - "omo": LinkedHashMap<String,Object>
For example, "BeanContext.pojoSwaps.lc" refers to a property on the BeanContext class called pojoSwaps that has a data type of List<Class>.
Property value normalization

Property values get 'normalized' when they get set. For example, calling propertyStore.set("BeanContext.debug.b", "true") will cause the property value to be converted to a boolean.
Set types

The "sX" property types are sorted sets.
Use these for collections of objects where the order is not important.
Internally, a TreeSet is used so that the order in which you add elements does not affect the resulting order of the property.
List types

The "lX" property types are ordered lists.
Use these in cases where the order in which entries are added is important.
Adding to a list property will cause the new entries to be added to the BEGINNING of the list.
This ensures that the resulting order of the list is in most-to-least importance.
For example, multiple calls to pojoSwaps() causes new entries to be added to the beginning of the list so that previous values can be 'overridden':
// Swap order: [MySwap2.class, MySwap1.class] JsonSerializer.create().pojoSwaps(MySwap1.class).pojoSwaps(MySwap2.class).build();

Note that the order is different when passing multiple values into the pojoSwaps() method, in which case the order should be first-match-wins:
// Swap order: [MySwap1.class, MySwap2.class] JsonSerializer.create().pojoSwaps(MySwap1.class,MySwap2.class).build();

Combined, the results look like this:
// Swap order: [MySwap4.class, MySwap3.class, MySwap1.class, MySwap2.class] JsonSerializer .create() .pojoSwaps(MySwap1.class,MySwap2.class) .pojoSwaps(MySwap3.class) .pojoSwaps(MySwap4.class) .build();

Map types

The "smX" and "omX" are sorted and order maps respectively.
Command properties

Set and list properties have the additional convenience 'command' names for adding and removing entries:
"{class}.{name}.{type}/add" // Add a value to the set/list. "{class}.{name}.{type}/remove" // Remove a value from the set/list.

Map properties have the additional convenience property name for adding and removing map entries:
"{class}.{name}.{type}/add.{key}" // Add a map entry (or delete if the value is null).

Setting properties

TODO
Retrieving properties

TODO

Field Summary

Fields
Modifier and Type Field and Description

static PropertyStore DEFAULT
A default empty property store.

Fields
Modifier and Type	Field and Description
`static PropertyStore`	`DEFAULT` A default empty property store.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PropertyStoreBuilder`	`builder()` Creates a new property store builder initialized with the values in this property store.
`static PropertyStoreBuilder`	`create()` Creates a new empty builder for a property store.
`boolean`	`equals(Object o)`
`boolean`	`equals(PropertyStore ps, String... groups)` Compares two property stores, but only based on the specified group names.
`<T> T[]`	`getArrayProperty(String key, Class<T> eType)` Returns the array property value with the specified name.
`<T> T[]`	`getArrayProperty(String key, Class<T> eType, T[] def)` Returns the array property value with the specified name.
`Class<?>[]`	`getClassArrayProperty(String key)` Returns the class array property with the specified name.
`Class<?>[]`	`getClassArrayProperty(String key, Class<?>[] def)` Returns the class array property with the specified name.
`<T> Class<T>[]`	`getClassArrayProperty(String key, Class<T> eType)` Returns the class array property with the specified name.
`List<Class<?>>`	`getClassListProperty(String key)` Returns the class list property with the specified name.
`<T> List<Class<T>>`	`getClassListProperty(String key, Class<T> eType)` Returns the class list property with the specified name.
`Map<String,Class<?>>`	`getClassMapProperty(String key)` Returns the class map property with the specified name.
`<T> Map<String,Class<T>>`	`getClassMapProperty(String key, Class<T> eType)` Returns the class map property with the specified name.
`<T> Class<? extends T>`	`getClassProperty(String key, Class<T> type, Class<? extends T> def)` Returns the class property with the specified name.
`Set<Class<?>>`	`getClassSetProperty(String key)` Returns the class set property with the specified name.
`<T> Set<Class<T>>`	`getClassSetProperty(String key, Class<T> eType)` Returns the class set property with the specified name.
`<T> T[]`	`getInstanceArrayProperty(String key, Class<T> type, T[] def)` Returns the specified property as an array of instantiated objects.
`<T> T[]`	`getInstanceArrayProperty(String key, Class<T> type, T[] def, boolean fuzzyArgs, Object... args)` Returns the specified property as an array of instantiated objects.
`<T> T[]`	`getInstanceArrayProperty(String key, Object outer, Class<T> type, T[] def, boolean fuzzyArgs, Object... args)` Returns the specified property as an array of instantiated objects.
`<T> T`	`getInstanceProperty(String key, Class<T> type, Object def)` Returns an instance of the specified class, string, or object property.
`<T> T`	`getInstanceProperty(String key, Class<T> type, Object def, boolean fuzzyArgs, Object... args)` Returns an instance of the specified class, string, or object property.
`<T> T`	`getInstanceProperty(String key, Object outer, Class<T> type, Object def, boolean fuzzyArgs, Object... args)` Returns an instance of the specified class, string, or object property.
`<T> List<T>`	`getListProperty(String key, Class<T> eType)` Returns the list property with the specified name.
`<T> List<T>`	`getListProperty(String key, Class<T> eType, List<T> def)` Returns the list property with the specified name.
`<T> Map<String,T>`	`getMapProperty(String key, Class<T> eType)` Returns the map property with the specified name.
`Object`	`getProperty(String key)` Returns the raw property value with the specified name.
`<T> T`	`getProperty(String key, Class<T> c, T def)` Returns the property value with the specified name.
`Set<String>`	`getPropertyKeys(String group)` Returns the keys found in the specified property group.
`<T> Set<T>`	`getSetProperty(String key, Class<T> eType)` Returns the set property with the specified name.
`<T> Set<T>`	`getSetProperty(String key, Class<T> eType, Set<T> def)` Returns the set property with the specified name.
`int`	`hashCode()`
`Integer`	`hashCode(String... groups)` Returns a hashcode of this property store using only the specified group names.
`Map<String,org.apache.juneau.PropertyStore.PropertyGroup>`	`swap(BeanSession beanSession)` Used for debugging.
`String`	`toString()`

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

- Field Detail
  - DEFAULT
```
public static PropertyStore DEFAULT
```
    A default empty property store.
- Method Detail
  - create
```
public static PropertyStoreBuilder create()
```
    Creates a new empty builder for a property store.
    
    Returns:
    
    A new empty builder for a property store.
  - builder
```
public PropertyStoreBuilder builder()
```
    Creates a new property store builder initialized with the values in this property store.
    
    Returns:
    
    A new property store builder.
  - getProperty
```
public Object getProperty(String key)
```
    Returns the raw property value with the specified name.
    
    Parameters:
    
    key - The property name.
    
    Returns:
    
    The property value, or null if it doesn't exist.
  - getProperty
```
public <T> T getProperty(String key,
                         Class<T> c,
                         T def)
```
    Returns the property value with the specified name.
    
    Parameters:
    
    key - The property name.
    
    c - The class to cast or convert the value to.
    
    def - The default value.
    
    Returns:
    
    The property value, or the default value if it doesn't exist.
  - getClassProperty
```
public <T> Class<? extends T> getClassProperty(String key,
                                               Class<T> type,
                                               Class<? extends T> def)
```
    Returns the class property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    type - The class type of the property.
    
    def - The default value.
    
    Returns:
    
    The property value, or the default value if it doesn't exist.
  - getArrayProperty
```
public <T> T[] getArrayProperty(String key,
                                Class<T> eType)
```
    Returns the array property value with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    Returns:
    
    The property value, or an empty array if it doesn't exist.
  - getArrayProperty
```
public <T> T[] getArrayProperty(String key,
                                Class<T> eType,
                                T[] def)
```
    Returns the array property value with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    def - The default value.
    
    Returns:
    
    The property value, or an empty array if it doesn't exist.
  - getClassArrayProperty
```
public Class<?>[] getClassArrayProperty(String key)
```
    Returns the class array property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    Returns:
    
    The property value, or an empty array if it doesn't exist.
  - getClassArrayProperty
```
public Class<?>[] getClassArrayProperty(String key,
                                        Class<?>[] def)
```
    Returns the class array property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    def - The default value.
    
    Returns:
    
    The property value, or an empty array if it doesn't exist.
  - getClassArrayProperty
```
public <T> Class<T>[] getClassArrayProperty(String key,
                                            Class<T> eType)
```
    Returns the class array property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    Returns:
    
    The property value, or an empty array if it doesn't exist.
  - getSetProperty
```
public <T> Set<T> getSetProperty(String key,
                                 Class<T> eType)
```
    Returns the set property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    Returns:
    
    The property value as an unmodifiable LinkedHashSet, or an empty set if it doesn't exist.
  - getSetProperty
```
public <T> Set<T> getSetProperty(String key,
                                 Class<T> eType,
                                 Set<T> def)
```
    Returns the set property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    def - The default value if the property doesn't exist or is empty.
    
    Returns:
    
    The property value as an unmodifiable LinkedHashSet, or the default value if it doesn't exist or is empty.
  - getClassSetProperty
```
public Set<Class<?>> getClassSetProperty(String key)
```
    Returns the class set property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    Returns:
    
    The property value as an unmodifiable LinkedHashSet, or an empty set if it doesn't exist.
  - getClassSetProperty
```
public <T> Set<Class<T>> getClassSetProperty(String key,
                                             Class<T> eType)
```
    Returns the class set property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    Returns:
    
    The property value as an unmodifiable LinkedHashSet, or an empty set if it doesn't exist.
  - getListProperty
```
public <T> List<T> getListProperty(String key,
                                   Class<T> eType)
```
    Returns the list property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    Returns:
    
    The property value as an unmodifiable ArrayList, or an empty list if it doesn't exist.
  - getListProperty
```
public <T> List<T> getListProperty(String key,
                                   Class<T> eType,
                                   List<T> def)
```
    Returns the list property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    def - The default value if the property doesn't exist or is empty.
    
    Returns:
    
    The property value as an unmodifiable ArrayList, or the default value if it doesn't exist or is empty.
  - getClassListProperty
```
public List<Class<?>> getClassListProperty(String key)
```
    Returns the class list property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    Returns:
    
    The property value as an unmodifiable ArrayList, or an empty list if it doesn't exist.
  - getClassListProperty
```
public <T> List<Class<T>> getClassListProperty(String key,
                                               Class<T> eType)
```
    Returns the class list property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    Returns:
    
    The property value as an unmodifiable ArrayList, or an empty list if it doesn't exist.
  - getMapProperty
```
public <T> Map<String,T> getMapProperty(String key,
                                        Class<T> eType)
```
    Returns the map property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    Returns:
    
    The property value as an unmodifiable LinkedHashMap, or an empty map if it doesn't exist.
  - getClassMapProperty
```
public Map<String,Class<?>> getClassMapProperty(String key)
```
    Returns the class map property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    Returns:
    
    The property value as an unmodifiable LinkedHashMap, or an empty map if it doesn't exist.
  - getClassMapProperty
```
public <T> Map<String,Class<T>> getClassMapProperty(String key,
                                                    Class<T> eType)
```
    Returns the class map property with the specified name.
    
    Parameters:
    
    key - The property name.
    
    eType - The class type of the elements in the property.
    
    Returns:
    
    The property value as an unmodifiable LinkedHashMap, or an empty map if it doesn't exist.
  - getInstanceProperty
```
public <T> T getInstanceProperty(String key,
                                 Class<T> type,
                                 Object def)
```
    Returns an instance of the specified class, string, or object property.
    If instantiating a class, assumes the class has a no-arg constructor. Otherwise, throws a runtime exception.
    
    Parameters:
    
    key - The property name.
    
    type - The class type of the property.
    
    def - The default value if the property doesn't exist.
    Can either be an instance of T, or a Class<? extends T>, or null.
    
    Returns:
    
    A new property instance.
  - getInstanceProperty
```
public <T> T getInstanceProperty(String key,
                                 Class<T> type,
                                 Object def,
                                 boolean fuzzyArgs,
                                 Object... args)
```
    Returns an instance of the specified class, string, or object property.
    
    Parameters:
    
    key - The property name.
    
    type - The class type of the property.
    
    def - The default value if the property doesn't exist.
    Can either be an instance of T, or a Class<? extends T>.
    
    fuzzyArgs - Use fuzzy constructor arg matching.
    When true, constructor args can be in any order and extra args are ignored.
    No-arg constructors are also used if no other constructors are found.
    
    args - Arguments to pass to the constructor. Constructors matching the arguments are always used before no-arg constructors.
    
    Returns:
    
    A new property instance.
  - getInstanceProperty
```
public <T> T getInstanceProperty(String key,
                                 Object outer,
                                 Class<T> type,
                                 Object def,
                                 boolean fuzzyArgs,
                                 Object... args)
```
    Returns an instance of the specified class, string, or object property.
    
    Parameters:
    
    key - The property name.
    
    outer - The outer object if the class we're instantiating is an inner class.
    
    type - The class type of the property.
    
    def - The default value if the property doesn't exist.
    Can either be an instance of T, or a Class<? extends T>.
    
    fuzzyArgs - Use fuzzy constructor arg matching.
    When true, constructor args can be in any order and extra args are ignored.
    No-arg constructors are also used if no other constructors are found.
    
    args - Arguments to pass to the constructor. Constructors matching the arguments are always used before no-arg constructors.
    
    Returns:
    
    A new property instance.
  - getInstanceArrayProperty
```
public <T> T[] getInstanceArrayProperty(String key,
                                        Class<T> type,
                                        T[] def)
```
    Returns the specified property as an array of instantiated objects.
    
    Parameters:
    
    key - The property name.
    
    type - The class type of the property.
    
    def - The default object to return if the property doesn't exist.
    
    Returns:
    
    A new property instance.
  - getInstanceArrayProperty
```
public <T> T[] getInstanceArrayProperty(String key,
                                        Class<T> type,
                                        T[] def,
                                        boolean fuzzyArgs,
                                        Object... args)
```
    Returns the specified property as an array of instantiated objects.
    
    Parameters:
    
    key - The property name.
    
    type - The class type of the property.
    
    def - The default object to return if the property doesn't exist.
    
    fuzzyArgs - Use fuzzy constructor arg matching.
    When true, constructor args can be in any order and extra args are ignored.
    No-arg constructors are also used if no other constructors are found.
    
    args - Arguments to pass to the constructor. Constructors matching the arguments are always used before no-arg constructors.
    
    Returns:
    
    A new property instance.
  - getInstanceArrayProperty
```
public <T> T[] getInstanceArrayProperty(String key,
                                        Object outer,
                                        Class<T> type,
                                        T[] def,
                                        boolean fuzzyArgs,
                                        Object... args)
```
    Returns the specified property as an array of instantiated objects.
    
    Parameters:
    
    key - The property name.
    
    outer - The outer object if the class we're instantiating is an inner class.
    
    type - The class type of the property.
    
    def - The default object to return if the property doesn't exist.
    
    fuzzyArgs - Use fuzzy constructor arg matching.
    When true, constructor args can be in any order and extra args are ignored.
    No-arg constructors are also used if no other constructors are found.
    
    args - Arguments to pass to the constructor. Constructors matching the arguments are always used before no-arg constructors.
    
    Returns:
    
    A new property instance.
  - getPropertyKeys
```
public Set<String> getPropertyKeys(String group)
```
    Returns the keys found in the specified property group.
    The keys are NOT prefixed with group names.
    
    Parameters:
    
    group - The group name.
    
    Returns:
    
    The set of property keys, or an empty set if the group was not found.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - hashCode
```
public Integer hashCode(String... groups)
```
    Returns a hashcode of this property store using only the specified group names.
    
    Parameters:
    
    groups - The names of the property groups to use in the calculation.
    
    Returns:
    
    The hashcode.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(PropertyStore ps,
                      String... groups)
```
    Compares two property stores, but only based on the specified group names.
    
    Parameters:
    
    ps - The property store to compare to.
    
    groups - The groups to compare.
    
    Returns:
    
    true if the two property stores are equal in the specified groups.
  - swap
```
public Map<String,org.apache.juneau.PropertyStore.PropertyGroup> swap(BeanSession beanSession)
```
    Used for debugging.
    Allows property stores to be serialized to easy-to-read JSON objects.
    
    Parameters:
    
    beanSession - The bean session.
    
    Returns:
    
    The property groups.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PropertyStore

Concept

PropertyStoreBuilder

Property naming convention

Property value normalization

Set types

List types

Map types

Command properties

Setting properties

Retrieving properties

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT

Method Detail

create

builder

getProperty

getProperty

getClassProperty

getArrayProperty

getArrayProperty

getClassArrayProperty

getClassArrayProperty

getClassArrayProperty

getSetProperty

getSetProperty

getClassSetProperty

getClassSetProperty

getListProperty

getListProperty

getClassListProperty

getClassListProperty

getMapProperty

getClassMapProperty

getClassMapProperty

getInstanceProperty

getInstanceProperty

getInstanceProperty

getInstanceArrayProperty

getInstanceArrayProperty

getInstanceArrayProperty

getPropertyKeys

hashCode

hashCode

equals

equals

swap

toString