org.codehaus.plexus.context
Interface Context


public interface Context


Method Summary
 boolean contains(java.lang.Object key)
           
 java.lang.Object get(java.lang.Object key)
           
 void hide(java.lang.Object key)
          Hides the item in the containerContext.
 void makeReadOnly()
          Make the containerContext read-only.
 void put(java.lang.Object key, java.lang.Object value)
          Adds the item to the containerContext.
 

Method Detail

get

java.lang.Object get(java.lang.Object key)
                     throws ContextException
Throws:
ContextException

contains

boolean contains(java.lang.Object key)

put

void put(java.lang.Object key,
         java.lang.Object value)
         throws java.lang.IllegalStateException
Adds the item to the containerContext.

Parameters:
key - the key of the item
value - the item
Throws:
java.lang.IllegalStateException - if containerContext is read only

hide

void hide(java.lang.Object key)
          throws java.lang.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
Throws:
java.lang.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.



Copyright © 2001-2010 Codehaus. All Rights Reserved.