org.apache.isis.core.commons.config

Class IsisConfigurationDefault

java.lang.Object

org.apache.isis.core.commons.config.IsisConfigurationDefault

All Implemented Interfaces:

Iterable<String>, Injectable, IsisConfiguration, Debuggable, DebuggableWithTitle

public class IsisConfigurationDefault
extends Object
implements IsisConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IsisConfigurationDefault.ContainsPolicy How to handle the case when the configuration already contains the key being added.

Constructor Summary

Constructors

Constructor and Description
IsisConfigurationDefault()
IsisConfigurationDefault(ResourceStreamSource resourceStreamSource)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Properties properties) Add the properties from an existing Properties object; if the key exists in the configuration then will be ignored.
void	add(Properties properties, IsisConfigurationDefault.ContainsPolicy policy) Add the properties from an existing Properties object; if the key exists in the configuration then the IsisConfigurationDefault.ContainsPolicy will be applied.
void	add(String key, String value) Adds a key-value pair to this set of properties; if the key exists in the configuration then will be ignored.
void	add(String key, String value, IsisConfigurationDefault.ContainsPolicy policy) Adds a key-value pair to this set of properties; if the key exists in the configuration then the IsisConfigurationDefault.ContainsPolicy will be applied.
Map<String,String>	asMap() A mutable copy of the current set of properties (name/values) held in this configuration.
IsisConfiguration	createSubset(String prefix) Creates a new IsisConfiguration containing the properties starting with the specified prefix.
void	debugData(DebugBuilder str) Debug details describing the object being investigated
String	debugTitle() The title for the debug information
boolean	getBoolean(String name) Gets the boolean value for the specified name where no value or 'on' will result in true being returned; anything gives false.
boolean	getBoolean(String name, boolean defaultValue) Gets the boolean value for the specified name.
Color	getColor(String name) Gets the color for the specified name.
Color	getColor(String name, Color defaultValue) Gets the color for the specified name.
Font	getFont(String name) Gets the font for the specified name.
Font	getFont(String name, Font defaultValue) Gets the font for the specified name.
int	getInteger(String name) Gets the number value for the specified name.
int	getInteger(String name, int defaultValue) Gets the number value for the specified name.
String[]	getList(String name) Returns a list of entries for the single configuration property with the specified name.
IsisConfiguration	getProperties(String withPrefix) Creates a new IsisConfiguration containing the properties starting with the specified prefix.
ResourceStreamSource	getResourceStreamSource() The ResourceStreamSource that was used to build this configuration.
String	getString(String name) Returns the configuration property with the specified name.
String	getString(String name, String defaultValue)
boolean	hasProperty(String name)
void	injectInto(Object candidate) Will inject itself into the candidate if the candidate implements the corresponding *Aware type.
boolean	isEmpty()
Iterator<String>	iterator() Iterates over the property names of this configuration.
void	put(Properties properties) Add the properties from an existing Properties object; if the key exists in the configuration then will be overwritten.
void	put(String key, String value) Adds a key-value pair to this set of properties; if the key exists in the configuration then will be replaced.
int	size()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IsisConfigurationDefault

public IsisConfigurationDefault()

IsisConfigurationDefault

public IsisConfigurationDefault(ResourceStreamSource resourceStreamSource)

Method Detail

getResourceStreamSource

public ResourceStreamSource getResourceStreamSource()

Description copied from interface: IsisConfiguration

The ResourceStreamSource that was used to build this configuration.

Specified by:

getResourceStreamSource in interface IsisConfiguration

See Also:

IsisConfigurationBuilder.getResourceStreamSource()

add

public void add(Properties properties)

Add the properties from an existing Properties object; if the key exists in the configuration then will be ignored.

See Also:

add(Properties, ContainsPolicy), put(Properties)

put

public void put(Properties properties)

Add the properties from an existing Properties object; if the key exists in the configuration then will be overwritten.

See Also:

add(Properties), add(Properties, ContainsPolicy)

add

public void add(Properties properties,
       IsisConfigurationDefault.ContainsPolicy policy)

Add the properties from an existing Properties object; if the key exists in the configuration then the IsisConfigurationDefault.ContainsPolicy will be applied.

See Also:

add(Properties), put(Properties)

add

public void add(String key,
       String value)

Adds a key-value pair to this set of properties; if the key exists in the configuration then will be ignored.

See Also:

add(String, String, ContainsPolicy), put(String, String)

put

public void put(String key,
       String value)

Adds a key-value pair to this set of properties; if the key exists in the configuration then will be replaced.

See Also:

add(String, String), add(String, String, ContainsPolicy)

add

public void add(String key,
       String value,
       IsisConfigurationDefault.ContainsPolicy policy)

Adds a key-value pair to this set of properties; if the key exists in the configuration then the IsisConfigurationDefault.ContainsPolicy will be applied.

See Also:

add(String, String), put(String, String)

createSubset

public IsisConfiguration createSubset(String prefix)

Description copied from interface: IsisConfiguration

Creates a new IsisConfiguration containing the properties starting with the specified prefix. The names of the new properties will have the prefixed stripped. This is similar to the IsisConfiguration.getProperties(String) method, except the property names have their prefixes removed.

Specified by:

createSubset in interface IsisConfiguration

See Also:

IsisConfiguration.getProperties(String)

getBoolean

public boolean getBoolean(String name)

Gets the boolean value for the specified name where no value or 'on' will result in true being returned; anything gives false. If no boolean property is specified with this name then false is returned.

Specified by:

getBoolean in interface IsisConfiguration

Parameters:

name - the property name

getBoolean

public boolean getBoolean(String name,
                 boolean defaultValue)

Gets the boolean value for the specified name. If no property is specified with this name then the specified default boolean value is returned.

Specified by:

getBoolean in interface IsisConfiguration

Parameters:

name - the property name

defaultValue - the value to use as a default

getColor

public Color getColor(String name)

Gets the color for the specified name. If no color property is specified with this name then null is returned.

Specified by:

getColor in interface IsisConfiguration

Parameters:

name - the property name

getColor

public Color getColor(String name,
             Color defaultValue)

Gets the color for the specified name. If no color property is specified with this name then the specified default color is returned.

Specified by:

getColor in interface IsisConfiguration

Parameters:

name - the property name

defaultValue - the value to use as a default

debugData

public void debugData(DebugBuilder str)

Description copied from interface: Debuggable

Debug details describing the object being investigated

Specified by:

debugData in interface Debuggable

debugTitle

public String debugTitle()

Description copied from interface: DebuggableWithTitle

The title for the debug information

Specified by:

debugTitle in interface DebuggableWithTitle

getFont

public Font getFont(String name)

Gets the font for the specified name. If no font property is specified with this name then null is returned.

Specified by:

getFont in interface IsisConfiguration

Parameters:

name - the property name

getFont

public Font getFont(String name,
           Font defaultValue)

Gets the font for the specified name. If no font property is specified with this name then the specified default font is returned.

Specified by:

getFont in interface IsisConfiguration

Parameters:

name - the property name

defaultValue - the color to use as a default

getInteger

public int getInteger(String name)

Gets the number value for the specified name. If no property is specified with this name then 0 is returned.

Specified by:

getInteger in interface IsisConfiguration

Parameters:

name - the property name

getInteger

public int getInteger(String name,
             int defaultValue)

Gets the number value for the specified name. If no property is specified with this name then the specified default number value is returned.

Specified by:

getInteger in interface IsisConfiguration

Parameters:

name - the property name

defaultValue - the value to use as a default

getList

public String[] getList(String name)

Description copied from interface: IsisConfiguration

Returns a list of entries for the single configuration property with the specified name.

If there is no matching property then returns an empty array.

Specified by:

getList in interface IsisConfiguration

getProperties

public IsisConfiguration getProperties(String withPrefix)

Description copied from interface: IsisConfiguration

Creates a new IsisConfiguration containing the properties starting with the specified prefix. The names of the properties in the copy are the same as in the original, ie the prefix is not removed. This is similar to the IsisConfiguration.createSubset(String) method except the names of the properties are not altered when copied.

Specified by:

getProperties in interface IsisConfiguration

See Also:

IsisConfiguration.createSubset(String)

getString

public String getString(String name)

Returns the configuration property with the specified name. If there is no matching property then null is returned.

Specified by:

getString in interface IsisConfiguration

getString

public String getString(String name,
               String defaultValue)

Specified by:

getString in interface IsisConfiguration

hasProperty

public boolean hasProperty(String name)

Specified by:

hasProperty in interface IsisConfiguration

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IsisConfiguration

iterator

public Iterator<String> iterator()

Description copied from interface: IsisConfiguration

Iterates over the property names of this configuration.

Specified by:

iterator in interface Iterable<String>

Specified by:

iterator in interface IsisConfiguration

size

public int size()

Specified by:

size in interface IsisConfiguration

toString

public String toString()

Overrides:

toString in class Object

injectInto

public void injectInto(Object candidate)

Description copied from interface: Injectable

Will inject itself into the candidate if the candidate implements the corresponding *Aware type.

Specified by:

injectInto in interface Injectable

asMap

public Map<String,String> asMap()

Description copied from interface: IsisConfiguration

A mutable copy of the current set of properties (name/values) held in this configuration.

Specified by:

asMap in interface IsisConfiguration