com.brambolt

Class Specification

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<java.lang.Object,java.lang.Object>

java.util.Properties

com.brambolt.Specification

All Implemented Interfaces:

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

Direct Known Subclasses:

ApplicationProperties, InstanceProperties, MasterProperties, SystemProperties

public class Specification
extends java.util.Properties

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
Specification()
Specification(java.util.Properties defaults)

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.lang.Object name) If Map#containsKey is invoked the result will be as expected when the parameter name exists as a property, but false when it was included in defaults.
java.util.Map<java.lang.String,java.lang.Object>	convertToMap()
java.util.Map<java.lang.String,java.lang.Object>	convertToMap(java.util.Collection<java.lang.String> keys)
java.lang.String	get(java.lang.Object name) This override is ugly but necessary; if #get in inadvertently invoked instead of #getProperty then all is well as long as the parameter name specifies a property that is present.
java.lang.Boolean	getBoolean(java.lang.String name) Accessor for a boolean property; returns true if the property value is "true", returns false in all other cases unless the property is not present in which case null is returned.
java.lang.Boolean	getBoolean(java.lang.String name, java.lang.Boolean defaultValue) Accessor for a boolean property; returns true if the property value is "true", returns false in all other cases except when the property is not present when the provided default value is returned.
java.lang.Integer	getInteger(java.lang.String name) Accessor for an integer property; returns the parsed integer if the property value can be parsed, returns null if the property is not defined and throws RuntimeException (with a wrapped NumberFormatException) if the property is available but can't be parsed to an integer.
java.lang.Integer	getInteger(java.lang.String name, java.lang.Integer defaultValue) Accessor for an integer property; returns the parsed integer if the property value can be parsed, returns a default if the property is not defined and throws RuntimeException (with a wrapped NumberFormatException) if the property is available but can't be parsed to an integer.
java.util.List<java.lang.String>	getKeys()
java.lang.String	getString(java.lang.String name) Accessor for a string property; returns the string value if the property value is defined, or returns null if the property is not defined.
java.lang.String	getString(java.lang.String name, java.lang.String defaultValue) Accessor for a string property; returns the string value if the property value exists, or returns a default if the property is not defined.
boolean	isEmpty()
java.lang.Boolean	isFalse(java.lang.String name)
java.lang.Boolean	isTrue(java.lang.String name)
protected void	loadProperties(java.lang.String path, java.io.InputStream inputStream)
static void	loadProperties(java.lang.String path, java.io.InputStream inputStream, java.util.Properties target)
protected void	loadPropertiesFromFile(java.io.File file)
protected void	loadPropertiesFromFile(java.lang.String filePath)
protected void	loadPropertiesFromList(java.lang.String key) Takes a parameter properties key with a list value and loads a properties file for each element in the list.
protected void	loadPropertiesFromResource(java.lang.String resourcePath)
static java.util.List<java.lang.String>	parseListing(java.lang.String value)

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsValue, elements, entrySet, equals, forEach, getOrDefault, hashCode, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Specification

public Specification()

Specification

public Specification(java.util.Properties defaults)

Method Detail

loadPropertiesFromList

protected void loadPropertiesFromList(java.lang.String key)

Takes a parameter properties key with a list value and loads a properties file for each element in the list. For example, for the parameter com.brambolt.calypso.hosts with the values brambolt,docker, two properties files are loaded from the classpath:

     com/brambolt/calypso/hosts/brambolt.properties
     com/brambolt/calypso/hosts/docker.properties
 

Parameters:

key - The list property key to load properties for

loadPropertiesFromResource

protected void loadPropertiesFromResource(java.lang.String resourcePath)

loadPropertiesFromFile

protected void loadPropertiesFromFile(java.lang.String filePath)

loadPropertiesFromFile

protected void loadPropertiesFromFile(java.io.File file)

loadProperties

protected void loadProperties(java.lang.String path,
                              java.io.InputStream inputStream)

loadProperties

public static void loadProperties(java.lang.String path,
                                  java.io.InputStream inputStream,
                                  java.util.Properties target)

getKeys

public java.util.List<java.lang.String> getKeys()

convertToMap

public java.util.Map<java.lang.String,java.lang.Object> convertToMap()

convertToMap

public java.util.Map<java.lang.String,java.lang.Object> convertToMap(java.util.Collection<java.lang.String> keys)

get

public java.lang.String get(java.lang.Object name)

This override is ugly but necessary; if #get in inadvertently invoked instead of #getProperty then all is well as long as the parameter name specifies a property that is present. But, if the name specifies a property that is only available in defaults then it will not be returned.

Specified by:

get in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

get in class java.util.Hashtable<java.lang.Object,java.lang.Object>

Parameters:

name - The name of the property to get the value for

Returns:

The property value, or null if no value is present

containsKey

public boolean containsKey(java.lang.Object name)

If Map#containsKey is invoked the result will be as expected when the parameter name exists as a property, but false when it was included in defaults.

Specified by:

containsKey in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

containsKey in class java.util.Hashtable<java.lang.Object,java.lang.Object>

Parameters:

name - The property name to check

Returns:

True iff the name has a value

getBoolean

public java.lang.Boolean getBoolean(java.lang.String name)

Accessor for a boolean property; returns true if the property value is "true", returns false in all other cases unless the property is not present in which case null is returned.

Parameters:

name - The property name to access

Returns:

The boolean value for the parameter property

getBoolean

public java.lang.Boolean getBoolean(java.lang.String name,
                                    java.lang.Boolean defaultValue)

Accessor for a boolean property; returns true if the property value is "true", returns false in all other cases except when the property is not present when the provided default value is returned.

Parameters:

name - The property name to access

defaultValue - The value to return if the property is not present

Returns:

The boolean value for the parameter property, or the default

isTrue

public java.lang.Boolean isTrue(java.lang.String name)

isFalse

public java.lang.Boolean isFalse(java.lang.String name)

getInteger

public java.lang.Integer getInteger(java.lang.String name)

Accessor for an integer property; returns the parsed integer if the property value can be parsed, returns null if the property is not defined and throws RuntimeException (with a wrapped NumberFormatException) if the property is available but can't be parsed to an integer. "

Parameters:

name - The property name to look up

Returns:

The integer value for the property, or null if not present

Throws:

java.lang.RuntimeException - If the value can't be parsed to an integer

getInteger

public java.lang.Integer getInteger(java.lang.String name,
                                    java.lang.Integer defaultValue)

Accessor for an integer property; returns the parsed integer if the property value can be parsed, returns a default if the property is not defined and throws RuntimeException (with a wrapped NumberFormatException) if the property is available but can't be parsed to an integer. "

Parameters:

name - The property name to look up

defaultValue - The default value when the property is not defined

Returns:

The integer value for the property, or the default if not present

Throws:

java.lang.RuntimeException - If the value can't be parsed to an integer

getString

public java.lang.String getString(java.lang.String name)

Accessor for a string property; returns the string value if the property value is defined, or returns null if the property is not defined. "

Parameters:

name - The property name to look up

Returns:

The string value for the property, or null if not present

getString

public java.lang.String getString(java.lang.String name,
                                  java.lang.String defaultValue)

Accessor for a string property; returns the string value if the property value exists, or returns a default if the property is not defined. "

Parameters:

name - The property name to look up

defaultValue - The default value when the property is not defined

Returns:

The string value for the property, or the default if not present

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

isEmpty in class java.util.Hashtable<java.lang.Object,java.lang.Object>

parseListing

public static java.util.List<java.lang.String> parseListing(java.lang.String value)