|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.configuration.event.EventSource org.apache.commons.configuration.AbstractConfiguration org.apache.commons.configuration.web.AppletConfiguration
public class AppletConfiguration
A configuration wrapper to read applet parameters. This configuration is read only, adding or removing a property will throw an UnsupportedOperationException.
Field Summary | |
---|---|
protected Applet |
applet
Stores the wrapped applet. |
Fields inherited from class org.apache.commons.configuration.AbstractConfiguration |
---|
END_TOKEN, EVENT_ADD_PROPERTY, EVENT_CLEAR, EVENT_CLEAR_PROPERTY, EVENT_READ_PROPERTY, EVENT_SET_PROPERTY, START_TOKEN |
Constructor Summary | |
---|---|
AppletConfiguration(Applet applet)
Create an AppletConfiguration using the initialization parameters of the specified Applet. |
Method Summary | |
---|---|
protected void |
addPropertyDirect(String key,
Object obj)
Adds a property to this configuration. |
void |
clearProperty(String key)
Removes the property with the given key. |
boolean |
containsKey(String key)
Checks whether the specified key is stored in this configuration. |
Iterator |
getKeys()
Get the list of the keys contained in the configuration. |
Object |
getProperty(String key)
Gets a property from the configuration. |
protected Object |
handleDelimiters(Object value)
Takes care of list delimiters in property values. |
boolean |
isEmpty()
Checks if this configuration is empty. |
Methods inherited from class org.apache.commons.configuration.event.EventSource |
---|
addConfigurationListener, addErrorListener, clearConfigurationListeners, clearErrorListeners, clone, createErrorEvent, createEvent, fireError, fireEvent, getConfigurationListeners, getErrorListeners, isDetailEvents, removeConfigurationListener, removeErrorListener, setDetailEvents |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected Applet applet
Constructor Detail |
---|
public AppletConfiguration(Applet applet)
applet
- the appletMethod Detail |
---|
public Object getProperty(String key)
Configuration
Configuration
interface the other get methods (that
return specific data types) will internally make use of this method. On
this level variable substitution is not yet performed. The returned
object is an internal representation of the property value for the passed
in key. It is owned by the Configuration
object. So a caller
should not modify this object. It cannot be guaranteed that this object
will stay constant over time (i.e. further update operations on the
configuration may change its internal state).
key
- property to retrieve
public Iterator getKeys()
Configuration
remove()
method is specific to
a concrete implementation. It may remove the corresponding
property from the configuration, but this is not guaranteed. In any case
it is no replacement for calling
Configuration.clearProperty(String)
for this property. So it is
highly recommended to avoid using the iterator's remove()
method.
public boolean isEmpty()
getKeys()
method (which must be defined by concrete
sub classes) to find out whether properties exist.
public boolean containsKey(String key)
key
- the key
public void clearProperty(String key)
clearProperty
in interface Configuration
clearProperty
in class AbstractConfiguration
key
- the key of the property to be removed
UnsupportedOperationException
- because this operation is not
allowedprotected void addPropertyDirect(String key, Object obj)
addPropertyDirect
in class AbstractConfiguration
key
- the key of the propertyobj
- the value to be added
UnsupportedOperationException
- because this operation is not
allowedprotected Object handleDelimiters(Object value)
value
- the property value to be examined
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |