org.apache.isis.core.commons.config

Interface IsisConfiguration

All Superinterfaces:

Debuggable, DebuggableWithTitle, Injectable, Iterable<String>

All Known Implementing Classes:

IsisConfigurationDefault

public interface IsisConfiguration
extends DebuggableWithTitle, Injectable, Iterable<String>

Immutable set of properties representing the configuration of the running system.

The IsisConfiguration is one part of a mutable/immutable pair pattern (cf String and StringBuilder). What this means is, as components are loaded they can discover their own configuration resources. These are added to IsisConfigurationBuilder.

Thus the IsisConfiguration held by different components may vary, but with each being a possible superset of the previous.

Method Summary

Methods

Modifier and Type	Method and Description
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.
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)
boolean	isEmpty()
Iterator<String>	iterator() Iterates over the property names of this configuration.
int	size()

Methods inherited from interface org.apache.isis.core.commons.debug.DebuggableWithTitle

debugTitle

Methods inherited from interface org.apache.isis.core.commons.debug.Debuggable

debugData

Methods inherited from interface org.apache.isis.core.commons.components.Injectable

injectInto

Method Detail

createSubset

IsisConfiguration createSubset(String prefix)

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 getProperties(String) method, except the property names have their prefixes removed.

See Also:

getProperties(String)

getBoolean

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.

Parameters:

name - the property name

getBoolean

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.

Parameters:

name - the property name

defaultValue - the value to use as a default

getColor

Color getColor(String name)

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

Parameters:

name - the property name

getColor

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.

Parameters:

name - the property name

defaultValue - the value to use as a default

getFont

Font getFont(String name)

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

Parameters:

name - the property name

getFont

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.

Parameters:

name - the property name

defaultValue - the color to use as a default

getList

String[] getList(String name)

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.

getInteger

int getInteger(String name)

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

Parameters:

name - the property name

getInteger

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.

Parameters:

name - the property name

defaultValue - the value to use as a default

getProperties

IsisConfiguration getProperties(String withPrefix)

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 createSubset(String) method except the names of the properties are not altered when copied.

See Also:

createSubset(String)

getString

String getString(String name)

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

getString

String getString(String name,
               String defaultValue)

hasProperty

boolean hasProperty(String name)

isEmpty

boolean isEmpty()

iterator

Iterator<String> iterator()

Iterates over the property names of this configuration.

Specified by:

iterator in interface Iterable<String>

size

int size()

getResourceStreamSource

ResourceStreamSource getResourceStreamSource()

The ResourceStreamSource that was used to build this configuration.

See Also:

IsisConfigurationBuilder.getResourceStreamSource()

asMap

Map<String,String> asMap()

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