org.springframework.extensions.config
Class ConfigLookupContext

java.lang.Object
  org.springframework.extensions.config.ConfigLookupContext

public class ConfigLookupContext
extends Object

Object to hold the context for a config lookup.

Author:

gavinc

Constructor Summary

ConfigLookupContext()
Default constructor

ConfigLookupContext(List<String> areas)
Constructs a lookup context for the list of the given areas

ConfigLookupContext(String area)
Constructs a lookup context for the given area

Method Summary

void	addArea(String area)
ConfigLookupAlgorithm	getAlgorithm()
List<String>	getAreas()
boolean	includeGlobalSection()
void	setAlgorithm(ConfigLookupAlgorithm algorithm)
void	setAreas(List<String> areas)
void	setIncludeGlobalSection(boolean includeGlobalSection)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigLookupContext

public ConfigLookupContext()

Default constructor

ConfigLookupContext

public ConfigLookupContext(String area)

Constructs a lookup context for the given area

Parameters:

area - The area to search in

ConfigLookupContext

public ConfigLookupContext(List<String> areas)

Constructs a lookup context for the list of the given areas

Parameters:

areas - The list of areas to search in

Method Detail

getAlgorithm

public ConfigLookupAlgorithm getAlgorithm()

Returns:

Returns the lookup algorithm, uses the default implementation if a custom algorithm is not supplied

setAlgorithm

public void setAlgorithm(ConfigLookupAlgorithm algorithm)

Parameters:

algorithm - Sets the lookup algorithm to use

getAreas

public List<String> getAreas()

Returns:

Returns the list of areas to search within

setAreas

public void setAreas(List<String> areas)

Parameters:

areas - Sets the lists of areas to search within

addArea

public void addArea(String area)

Parameters:

area - Adds the area to the list of areas to be searched

includeGlobalSection

public boolean includeGlobalSection()

Returns:

Determines whether the global section should be included in the results, true by default

setIncludeGlobalSection

public void setIncludeGlobalSection(boolean includeGlobalSection)

Parameters:

includeGlobalSection - Sets whether the global section will be included in the results