org.apache.shindig.config

Class BasicContainerConfig

java.lang.Object

org.apache.shindig.config.BasicContainerConfig

All Implemented Interfaces:

ContainerConfig

Direct Known Subclasses:

ExpressionContainerConfig

public class BasicContainerConfig
extends Object
implements ContainerConfig

Basic container configuration class, without expression support. We use a cascading model, so you only have to specify attributes in your config that you actually want to change. Configurations can be added/modified/removed using transactions. The configuration is protected with a read/write lock.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BasicContainerConfig.BasicTransaction

Nested classes/interfaces inherited from interface org.apache.shindig.config.ContainerConfig

ContainerConfig.ConfigObserver, ContainerConfig.Transaction

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Map<String,Object>>	config
protected Set<ContainerConfig.ConfigObserver>	observers

Fields inherited from interface org.apache.shindig.config.ContainerConfig

CONTAINER_KEY, DEFAULT_CONTAINER, PARENT_KEY

Constructor Summary

Constructors

Constructor and Description
BasicContainerConfig()

Method Summary

Methods

Modifier and Type	Method and Description
void	addConfigObserver(ContainerConfig.ConfigObserver observer, boolean notifyNow) Adds an observer that will be notified when the configuration changes.
boolean	getBool(String container, String property)
Collection<String>	getContainers()
int	getInt(String container, String property)
<T> List<T>	getList(String container, String property)
<T> Map<String,T>	getMap(String container, String property)
Map<String,Object>	getProperties(String container) Fetch all properties for the given container configuration.
Object	getProperty(String container, String name)
String	getString(String container, String property)
ContainerConfig.Transaction	newTransaction() Creates a new transaction to create, modify or remove containers.
protected void	notifyObservers(Collection<String> changed, Collection<String> removed) Notifies the configuration observers that some containers' configurations have been changed.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

observers

protected final Set<ContainerConfig.ConfigObserver> observers

config

protected Map<String,Map<String,Object>> config

Constructor Detail

BasicContainerConfig

public BasicContainerConfig()

Method Detail

getContainers

public Collection<String> getContainers()

Specified by:

getContainers in interface ContainerConfig

Returns:

The set of all containers that are currently registered.

getProperties

public Map<String,Object> getProperties(String container)

Description copied from interface: ContainerConfig

Fetch all properties for the given container configuration.

Specified by:

getProperties in interface ContainerConfig

getProperty

public Object getProperty(String container,
                 String name)

Specified by:

getProperty in interface ContainerConfig

Returns:

The configuration property stored under the given name for the given container.

getString

public String getString(String container,
               String property)

Specified by:

getString in interface ContainerConfig

Returns:

The configuration property stored under the given name for the given container, or null if it is not defined or not a string.

getInt

public int getInt(String container,
         String property)

Specified by:

getInt in interface ContainerConfig

Returns:

The configuration property stored under the given name for the given container, or 0 if it is not defined or not a number.

getBool

public boolean getBool(String container,
              String property)

Specified by:

getBool in interface ContainerConfig

Returns:

The configuration property stored under the given name for the given container, or false if it is not defined or not a boolean.

getList

public <T> List<T> getList(String container,
                  String property)

Specified by:

getList in interface ContainerConfig

Returns:

The configuration property stored under the given name for the given container, or an empty list if it is not defined or not a list.

getMap

public <T> Map<String,T> getMap(String container,
                       String property)

Specified by:

getMap in interface ContainerConfig

Returns:

The configuration property stored under the given name for the given container, or an empty map if it is not defined or not a map.

addConfigObserver

public void addConfigObserver(ContainerConfig.ConfigObserver observer,
                     boolean notifyNow)

Description copied from interface: ContainerConfig

Adds an observer that will be notified when the configuration changes.

Specified by:

addConfigObserver in interface ContainerConfig

Parameters:

observer - The observer to be notified.

notifyNow - If true, the observer will receive an immediate notification for the current configuration.

newTransaction

public ContainerConfig.Transaction newTransaction()

Description copied from interface: ContainerConfig

Creates a new transaction to create, modify or remove containers.

Specified by:

newTransaction in interface ContainerConfig

Returns:

The new transaction object.

notifyObservers

protected void notifyObservers(Collection<String> changed,
                   Collection<String> removed)

Notifies the configuration observers that some containers' configurations have been changed.

Parameters:

changed - The names of the containers that have been added or changed.

removed - The names of the containers that have been removed.

toString

public String toString()

Overrides:

toString in class Object