PropertyHolder (appNG Parent 1.26.2-SNAPSHOT API)

java.lang.Object
- org.appng.api.support.PropertyHolder

All Implemented Interfaces:

Properties

Direct Known Subclasses:

PersistentPropertyHolder
```
public class PropertyHolder
extends Object
implements Properties
```
Default Properties implementation, internally holding a Map of Property-objects.

Author:

Matthias Müller

Constructor Summary

Constructors
Constructor and Description

PropertyHolder()

PropertyHolder(String prefix, Iterable<? extends Property> properties)
Creates a new PropertyHolder

Constructors
Constructor and Description
`PropertyHolder()`
`PropertyHolder(String prefix, Iterable<? extends Property> properties)` Creates a new `PropertyHolder`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Property`	`addProperty(String name, Object defaultValue, String description, Property.Type type)` As long as `setFinal()` has not be called, this method can be used to add new properties
`byte[]`	`getBlob(String name)` Returns the byte-value of the given `Property`.
`Boolean`	`getBoolean(String name)` Returns a `Boolean` parsed from the given `Property` (if existing).
`Boolean`	`getBoolean(String name, Boolean defaultValue)`
`String`	`getClob(String name)` Returns the string-value of the given `Property`.
`String`	`getClob(String name, String defaultValue)` Returns the string-value of the given `Property` (if existing), or the default-value.
`String`	`getDescriptionFor(String name)` Returns the description for the `Property` with the given name, if any
`Double`	`getDouble(String name)` Returns an `Double` parsed from the given `Property` (if existing).
`Double`	`getDouble(String name, Double defaultValue)` Returns a `Double` parsed from the given `Property` (if existing), or the default-value.
`Float`	`getFloat(String name)` Returns an `Float` parsed from the given `Property` (if existing).
`Float`	`getFloat(String name, Float defaultValue)` Returns a `Float` parsed from the given `Property` (if existing), or the default-value.
`Integer`	`getInteger(String name)` Returns an `Integer` parsed from the given `Property` (if existing).
`Integer`	`getInteger(String name, Integer defaultValue)` Returns an `Integer` parsed from the given `Property` (if existing), or the default-value.
`List<String>`	`getList(String name, String delimiter)` Returns a `List` of `String`s which is parsed from the value of the `Property` with the given name (if present).
`List<String>`	`getList(String name, String defaultValue, String delimiter)` Returns a `List` of `String`s which is parsed from the value of the `Property` with the given name (if present) or from the default-value.
`protected SimpleProperty`	`getNewProperty(String name)`
`Object`	`getObject(String name)` Returns the object representation of the `Property` according to it's `Property.Type`: an `Integer` (for type `Property.Type.INT`) a `Double` (for type `Property.Type.DECIMAL`) a `Boolean` (for type `Property.Type.BOOLEAN`) a `String` (for types `Property.Type.TEXT`, `Property.Type.PASSWORD` and `Property.Type.MULTILINE`)
`<T> T`	`getObject(String name, T defaultValue)`
`Properties`	`getPlainProperties()` Takes this `Properties` and transforms it into some (plain, old, uncool) `Properties`.
`Properties`	`getProperties(String name)` Returns some `Properties` parsed from the given `Property` (if existing).
`Property`	`getProperty(String name)`
`Set<String>`	`getPropertyNames()` Returns all `Property` names.
`String`	`getString(String name)` Returns the string-value of the given `Property`.
`String`	`getString(String name, String defaultValue)` Returns the string-value of the given `Property` (if existing), or the default-value.
`boolean`	`propertyExists(String name)` Checks whether the `Property` with the given name exists.
`PropertyHolder`	`setFinal()` Sets this `PropertyHolder` to final, which means no more properties can be added using `#addProperty(String, Object, String, Type)`.
`String`	`toString()`

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

- Constructor Detail
  - PropertyHolder
```
public PropertyHolder(String prefix,
                      Iterable<? extends Property> properties)
```
    Creates a new PropertyHolder
    
    Parameters:
    
    prefix - the prefix to use
    
    properties - the Property-instances to hold
  - PropertyHolder
```
public PropertyHolder()
```
- Method Detail
  - setFinal
```
public PropertyHolder setFinal()
```
    Sets this PropertyHolder to final, which means no more properties can be added using #addProperty(String, Object, String, Type).
    
    Returns:
    
    this PropertyHolder
  - getPropertyNames
```
public Set<String> getPropertyNames()
```
    Description copied from interface: Properties
    
    Returns all Property names.
    
    Specified by:
    
    getPropertyNames in interface Properties
    
    Returns:
    
    all Property names
  - propertyExists
```
public boolean propertyExists(String name)
```
    Description copied from interface: Properties
    
    Checks whether the Property with the given name exists.
    
    Specified by:
    
    propertyExists in interface Properties
    
    Parameters:
    
    name - the name of the Property
    
    Returns:
    
    true if the Property exists, false otherwise
  - getProperty
```
public Property getProperty(String name)
```
  - getString
```
public String getString(String name,
                        String defaultValue)
```
    Description copied from interface: Properties
    
    Returns the string-value of the given Property (if existing), or the default-value.
    
    Specified by:
    
    getString in interface Properties
    
    Parameters:
    
    name - the name of the Property
    
    defaultValue - the default-value
    
    Returns:
    
    the string-value of the given Property (if existing), or the default-value
  - addProperty
```
public final Property addProperty(String name,
                                  Object defaultValue,
                                  String description,
                                  Property.Type type)
```
    As long as setFinal() has not be called, this method can be used to add new properties
    
    Parameters:
    
    name - the name of the property, without prefix
    
    defaultValue - the default value for the property to add, must not be null
    
    description - the description for the property
    
    type - the type of the property
    
    Throws:
    
    IllegalArgumentException - if defaultValue is null or if setFinal() has been called before.
  - getNewProperty
```
protected SimpleProperty getNewProperty(String name)
```
  - getBoolean
```
public Boolean getBoolean(String name)
```
    Description copied from interface: Properties
    
    Returns a Boolean parsed from the given Property (if existing).
    
    Specified by:
    
    getBoolean in interface Properties
    
    Parameters:
    
    name - the name of the Property
    
    Returns:
    
    a Boolean, or null if no such Property exists.
  - getBoolean
```
public Boolean getBoolean(String name,
                          Boolean defaultValue)
```
    Specified by:
    
    getBoolean in interface Properties
    
    Parameters:
    
    name - the name of the Property
    
    defaultValue - the default-value
    
    Returns:
    
    a Boolean, or the default-value if no such Property exists.
  - getInteger
```
public Integer getInteger(String name,
                          Integer defaultValue)
```
    Description copied from interface: Properties
    
    Returns an Integer parsed from the given Property (if existing), or the default-value.
    
    Specified by:
    
    getInteger in interface Properties
    
    Parameters:
    
    name - the name of the Property
    
    defaultValue - the default-value
    
    Returns:
    
    an Integer, or the default-value if no such Property exists.
  - getFloat
```
public Float getFloat(String name,
                      Float defaultValue)
```
    Description copied from interface: Properties
    
    Returns a Float parsed from the given Property (if existing), or the default-value.
    
    Specified by:
    
    getFloat in interface Properties
    
    Parameters:
    
    name - the name of the Property
    
    defaultValue - the default-value
    
    Returns:
    
    an Float, or the default-value if no such Property exists.
  - getDouble
```
public Double getDouble(String name,
                        Double defaultValue)
```
    Description copied from interface: Properties
    
    Returns a Double parsed from the given Property (if existing), or the default-value.
    
    Specified by:
    
    getDouble in interface Properties
    
    Parameters:
    
    name - the name of the Property
    
    defaultValue - the default-value
    
    Returns:
    
    a Double, or the default-value if no such Property exists.
  - getBlob
```
public byte[] getBlob(String name)
```
    Description copied from interface: Properties
    
    Returns the byte-value of the given Property.
    
    Specified by:
    
    getBlob in interface Properties
    
    Parameters:
    
    name - the name of the Property
    
    Returns:
    
    the byte-value of the given Property, or null if no such Property exists.
  - getClob
```
public String getClob(String name,
                      String defaultValue)
```
    Description copied from interface: Properties
    
    Returns the string-value of the given Property (if existing), or the default-value.
    
    Specified by:
    
    getClob in interface Properties
    
    Parameters:
    
    name - the name of the Property
    
    defaultValue - the default-value
    
    Returns:
    
    the string-value of the given Property (if existing), or the default-value
  - getString
```
public String getString(String name)
```
    Description copied from interface: Properties
    
    Returns the string-value of the given Property.
    
    Specified by:
    
    getString in interface Properties
    
    Parameters:
    
    name - the name of the Property
    
    Returns:
    
    the string-value of the given Property, or null if no such property exists.
  - getInteger
```
public Integer getInteger(String name)
```
    Description copied from interface: Properties
    
    Returns an Integer parsed from the given Property (if existing).
    
    Specified by:
    
    getInteger in interface Properties
    
    Parameters:
    
    name - the name of the Property
    
    Returns:
    
    an Integer, or null if no such Property exists.
  - getFloat
```
public Float getFloat(String name)
```
    Description copied from interface: Properties
    
    Returns an Float parsed from the given Property (if existing).
    
    Specified by:
    
    getFloat in interface Properties
    
    Parameters:
    
    name - the name of the Property
    
    Returns:
    
    an Float, or null if no such Property exists.
  - getDouble
```
public Double getDouble(String name)
```
    Description copied from interface: Properties
    
    Returns an Double parsed from the given Property (if existing).
    
    Specified by:
    
    getDouble in interface Properties
    
    Parameters:
    
    name - the name of the Property
    
    Returns:
    
    an Double, or null if no such Property exists.
  - getClob
```
public String getClob(String name)
```
    Description copied from interface: Properties
    
    Returns the string-value of the given Property.
    
    Specified by:
    
    getClob in interface Properties
    
    Parameters:
    
    name - the name of the Property
    
    Returns:
    
    the string-value of the given Property, or null if no such Property exists.
  - getObject
```
public Object getObject(String name)
```
    Description copied from interface: Properties
    Returns the object representation of the Property according to it's Property.Type:
    - an Integer (for type Property.Type.INT)
    - a Double (for type Property.Type.DECIMAL)
    - a Boolean (for type Property.Type.BOOLEAN)
    - a String (for types Property.Type.TEXT, Property.Type.PASSWORD and Property.Type.MULTILINE)
    Specified by:
    
    getObject in interface Properties
    
    Parameters:
    
    name - the name of the property
    
    Returns:
    
    the object representation
  - getObject
```
public <T> T getObject(String name,
                       T defaultValue)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getList
```
public List<String> getList(String name,
                            String defaultValue,
                            String delimiter)
```
    Description copied from interface: Properties
    
    Returns a List of Strings which is parsed from the value of the Property with the given name (if present) or from the default-value.
    
    Specified by:
    
    getList in interface Properties
    
    Parameters:
    
    name - the name of the Property
    
    defaultValue - the default-string to parse the list from
    
    delimiter - the delimiter to split the (default-)value by
    
    Returns:
    
    a (possibly empty) List, never null
  - getList
```
public List<String> getList(String name,
                            String delimiter)
```
    Description copied from interface: Properties
    
    Returns a List of Strings which is parsed from the value of the Property with the given name (if present).
    
    Specified by:
    
    getList in interface Properties
    
    Parameters:
    
    name - the name of the Property
    
    delimiter - the delimiter to split the value by
    
    Returns:
    
    List of Strings which is parsed from the value of the Property with the given name (if present)
  - getPlainProperties
```
public Properties getPlainProperties()
```
    Description copied from interface: Properties
    
    Takes this Properties and transforms it into some (plain, old, uncool) Properties.
    
    Specified by:
    
    getPlainProperties in interface Properties
    
    Returns:
    
    some Properties
  - getProperties
```
public Properties getProperties(String name)
```
    Description copied from interface: Properties
    
    Returns some Properties parsed from the given Property (if existing).
    
    Specified by:
    
    getProperties in interface Properties
    
    Parameters:
    
    name - the name of the Property
    
    Returns:
    
    some Properties, or null if no such Property exists.
  - getDescriptionFor
```
public String getDescriptionFor(String name)
```
    Description copied from interface: Properties
    
    Returns the description for the Property with the given name, if any
    
    Specified by:
    
    getDescriptionFor in interface Properties
    
    Parameters:
    
    name - the name of the property
    
    Returns:
    
    the description, if any

Class PropertyHolder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PropertyHolder

PropertyHolder

Method Detail

setFinal

getPropertyNames

propertyExists

getProperty

getString

addProperty

getNewProperty

getBoolean

getBoolean

getInteger

getFloat

getDouble

getBlob

getClob

getString

getInteger

getFloat

getDouble

getClob

getObject

getObject

toString

getList

getList

getPlainProperties

getProperties

getDescriptionFor