org.apache.isis.core.commons.config

Class IsisConfigurationBuilderResourceStreams

java.lang.Object

org.apache.isis.core.commons.config.IsisConfigurationBuilderResourceStreams

All Implemented Interfaces:

Injectable, IsisConfigurationBuilder

Direct Known Subclasses:

IsisConfigurationBuilderDefault, IsisConfigurationBuilderFileSystem, IsisConfigurationBuilderForWebapp

public class IsisConfigurationBuilderResourceStreams
extends Object
implements IsisConfigurationBuilder

Adapter for IsisConfigurationBuilder, loading the specified configuration resource (file) from the given ResourceStreamSource(s).

If a property is in multiple configuration resources then the latter resources will overwrite the former.

Constructor Summary

Constructors

Constructor and Description
IsisConfigurationBuilderResourceStreams()
IsisConfigurationBuilderResourceStreams(ResourceStreamSource... resourceStreamSources)
IsisConfigurationBuilderResourceStreams(ResourceStreamSource resourceStreamSource)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(String key, String value) Adds additional property.
void	addConfigurationResource(String configurationResource, NotFoundPolicy notFoundPolicy) Registers the configuration resource (usually, a file) with the specified name from the first ResourceStreamSource available.
void	addDefaultConfigurationResources() May be overridden by subclasses if required.
void	dumpResourcesToLog() Log a summary of resources found or not found.
IsisConfiguration	getConfiguration() Returns the current configuration.
ResourceStreamSource	getResourceStreamSource() The underlying ResourceStreamSource from which the configuration is being read.
void	injectInto(Object candidate) Will inject itself into the candidate if the candidate implements the corresponding *Aware type.
protected void	loadConfigurationResource(IsisConfigurationDefault configuration, String configurationResource, NotFoundPolicy notFoundPolicy) Loads the configuration resource (usually, a file) with the specified name from the first ResourceStreamSource available.
void	lockConfiguration()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IsisConfigurationBuilderResourceStreams

public IsisConfigurationBuilderResourceStreams()

IsisConfigurationBuilderResourceStreams

public IsisConfigurationBuilderResourceStreams(ResourceStreamSource... resourceStreamSources)

IsisConfigurationBuilderResourceStreams

public IsisConfigurationBuilderResourceStreams(ResourceStreamSource resourceStreamSource)

Method Detail

addDefaultConfigurationResources

public void addDefaultConfigurationResources()

May be overridden by subclasses if required.

Specified by:

addDefaultConfigurationResources in interface IsisConfigurationBuilder

getResourceStreamSource

public ResourceStreamSource getResourceStreamSource()

Description copied from interface: IsisConfigurationBuilder

The underlying ResourceStreamSource from which the configuration is being read.

Note that this may be a composite.

Specified by:

getResourceStreamSource in interface IsisConfigurationBuilder

addConfigurationResource

public void addConfigurationResource(String configurationResource,
                            NotFoundPolicy notFoundPolicy)

Registers the configuration resource (usually, a file) with the specified name from the first ResourceStreamSource available.

If the configuration resource cannot be found then the provided NotFoundPolicy determines whether an exception is thrown or not.

Must be called before getConfiguration(); the resource is actually read on getConfiguration().

Specified by:

addConfigurationResource in interface IsisConfigurationBuilder

add

public void add(String key,
       String value)

Adds additional property.

Specified by:

add in interface IsisConfigurationBuilder

lockConfiguration

public void lockConfiguration()

Specified by:

lockConfiguration in interface IsisConfigurationBuilder

getConfiguration

public IsisConfiguration getConfiguration()

Returns the current configuration.

Specified by:

getConfiguration in interface IsisConfigurationBuilder

loadConfigurationResource

protected void loadConfigurationResource(IsisConfigurationDefault configuration,
                             String configurationResource,
                             NotFoundPolicy notFoundPolicy)

Loads the configuration resource (usually, a file) with the specified name from the first ResourceStreamSource available.

If the configuration resource cannot be found then the provided NotFoundPolicy determines whether an exception is thrown or not.

dumpResourcesToLog

public void dumpResourcesToLog()

Description copied from interface: IsisConfigurationBuilder

Log a summary of resources found or not found.

Specified by:

dumpResourcesToLog in interface IsisConfigurationBuilder

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

toString

public String toString()

Overrides:

toString in class Object