org.codehaus.plexus.context

Interface Context

public interface Context

Context of the plexus container.

Method Summary

boolean
contains(Object key)
Returns true if the map or the parent map contains the key.
Object
get(Object key)
Returns the value of the key.
Map
getContextData()
Utility method to retrieve containerContext data.
void
hide(Object key)
Hides the item in the containerContext.
void
makeReadOnly()
Make the containerContext read-only.
void
put(Object key, Object value)
Adds the item to the containerContext.

Method Details

contains

public boolean contains(Object key)
Returns true if the map or the parent map contains the key.
Parameters:
key - The key to search for.
Returns:
Returns true if the key was found.

get

public Object get(Object key)
            throws ContextException
Returns the value of the key. If the key can't be found it will throw a exception.
Parameters:
key - The key of the value to look up.
Returns:
Returns
Throws:
ContextException - If the key doesn't exist.

getContextData

public Map getContextData()
Utility method to retrieve containerContext data. the returned Map is an unmodifiable view.
Returns:
the containerContext data
Since:
1.0-alpha-18

hide

public void hide(Object key)
            throws IllegalStateException
Hides the item in the containerContext. After remove(key) has been called, a get(key) will always fail, even if the parent containerContext has such a mapping.
Parameters:
key - the items key

makeReadOnly

public void makeReadOnly()
Make the containerContext read-only. Any attempt to write to the containerContext via put() will result in an IllegalStateException.

put

public void put(Object key,
                Object value)
            throws IllegalStateException
Adds the item to the containerContext.
Parameters:
key - the key of the item
value - the item