Package org.codehaus.plexus.context
Interface Context
public interface Context
Context of the plexus container.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns true if the map or the parent map contains the key.Returns the value of the key.Utility method to retrieve containerContext data.void
Hides the item in the containerContext.void
Make the containerContext read-only.void
Adds the item to the containerContext.
-
Method Details
-
get
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
Map getContextData()Utility method to retrieve containerContext data. the returned Map is an unmodifiable view.- Returns:
- the containerContext data
- Since:
- 1.0-alpha-18
-
contains
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.
-
put
Adds the item to the containerContext.- Parameters:
key
- the key of the itemvalue
- the item- Throws:
IllegalStateException
- if containerContext is read only
-
hide
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- Throws:
IllegalStateException
- if containerContext is read only
-
makeReadOnly
void makeReadOnly()Make the containerContext read-only. Any attempt to write to the containerContext via put() will result in an IllegalStateException.
-