org.codehaus.plexus.context
Class DefaultContext

java.lang.Object
  org.codehaus.plexus.context.DefaultContext

All Implemented Interfaces:

Context

public class DefaultContext
extends java.lang.Object
implements Context

Default implementation of Context. This implementation is a static hierarchial store. It has the normal get() and put methods. The hide method will hide a property. When a property has been hidden the context will not search in the parent context for the value.

Version:

$Id: DefaultContext.java 4122 2006-09-18 13:54:16Z evenisse $

Author:

Avalon Development Team

Constructor Summary

DefaultContext()
Create a empty Context with no parent.

DefaultContext(Context parent)
Create a Context with specified parent.

DefaultContext(java.util.Map contextData)
Create a empty Context with specified data.

DefaultContext(java.util.Map contextData, Context parent)
Create a Context with specified data and parent.

Method Summary

protected void	checkWriteable() Utility method to check if context is writeable and if not throw exception.
boolean	contains(java.lang.Object key) Returns true if the map or the parent map contains the key.
java.lang.Object	get(java.lang.Object key) Returns the value of the key.
java.util.Map	getContextData() Utility method to retrieve context data.
protected Context	getParent() Get parent context if any.
void	hide(java.lang.Object key) Hides the item in the context.
void	makeReadOnly() Make the context read-only.
void	put(java.lang.Object key, java.lang.Object value) Helper method for adding items to Context.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultContext

public DefaultContext(java.util.Map contextData,
                      Context parent)

Create a Context with specified data and parent.

Parameters:

contextData - the context data

parent - the parent Context (may be null)

DefaultContext

public DefaultContext(java.util.Map contextData)

Create a empty Context with specified data.

Parameters:

contextData - the context data

DefaultContext

public DefaultContext(Context parent)

Create a Context with specified parent.

Parameters:

parent - the parent Context (may be null)

DefaultContext

public DefaultContext()

Create a empty Context with no parent.

Method Detail

contains

public boolean contains(java.lang.Object key)

Returns true if the map or the parent map contains the key.

Specified by:

contains in interface Context

Parameters:

key - The key to search for.

Returns:

Returns true if the key was found.

get

public java.lang.Object get(java.lang.Object key)
                     throws ContextException

Returns the value of the key. If the key can't be found it will throw a exception.

Specified by:

get in interface Context

Parameters:

key - The key of the value to look up.

Returns:

Returns

Throws:

ContextException - If the key doesn't exist.

put

public void put(java.lang.Object key,
                java.lang.Object value)
         throws java.lang.IllegalStateException

Helper method for adding items to Context.

Specified by:

put in interface Context

Parameters:

key - the items key

value - the item

Throws:

java.lang.IllegalStateException - if context is read only

hide

public void hide(java.lang.Object key)
          throws java.lang.IllegalStateException

Hides the item in the context. After remove(key) has been called, a get(key) will always fail, even if the parent context has such a mapping.

Specified by:

hide in interface Context

Parameters:

key - the items key

Throws:

java.lang.IllegalStateException - if context is read only

getContextData

public java.util.Map getContextData()

Utility method to retrieve context data.

Returns:

the context data

getParent

protected Context getParent()

Get parent context if any.

Returns:

the parent Context (may be null)

makeReadOnly

public void makeReadOnly()

Make the context read-only. Any attempt to write to the context via put() will result in an IllegalStateException.

Specified by:

makeReadOnly in interface Context

checkWriteable

protected void checkWriteable()
                       throws java.lang.IllegalStateException

Utility method to check if context is writeable and if not throw exception.

Throws:

java.lang.IllegalStateException - if context is read only