get
public java.lang.Object get(java.lang.String key)
- Get an item from a property bag.
- Specified by:
get in interface com.sas.collection.StaticPropertyBagInterface
- Parameters:
key - the name of the property.
This string must be
an interned string and may not be null.
(Use aString.intern() to create an interned string.)
Returns:the object associated with the key
Throws:
java.util.NoSuchElementException - if there
is no such property in the property bag.
(this is necessary to distinguish between
no such key and a property value of null.)
get
public java.lang.Object get(java.lang.String key,
java.lang.Object defaultValue)
- Get an item from a property bag, or return a default if it does not exist.
- Specified by:
get in interface com.sas.collection.StaticPropertyBagInterface
- Parameters:
key - the name of the property.
This string must be
an interned string and may not be null.
(Use aString.intern() to create an interned string.)defaultValue - a default value to return if the named property does
not exist in the property bag
Returns:the object associated with the key, or the defaultValue
if the bag does not contain an element for the specified key.
toDictionary
public com.sas.collection.DictionaryInterface toDictionary(com.sas.collection.DictionaryInterface initialDictionary)
- Place the property bag items into a dictionary and return that
dictionary.
- Specified by:
toDictionary in interface com.sas.collection.StaticPropertyBagInterface
- Parameters:
initialDictionary - a dictionary into which the property bag
places all of its values via. This may be null, in which case
a new Dictionary is created.
- Returns:
- the dictionary containing the property bag contents.
- See Also:
Dictionary,
DictionaryInterface.set(Object,Object)
listKeys
public java.lang.String[] listKeys()
- Return a list of the keys for this property bag.
- Specified by:
listKeys in interface com.sas.collection.StaticPropertyBagInterface
- Returns:
- an array containing the property keys
- See Also:
StringCollection
clone
public java.lang.Object clone()
throws java.lang.CloneNotSupportedException
- Clone a dynamic property bag.
- Specified by:
clone in interface com.sas.collection.StaticPropertyBagInterface- Specified by:
clone in interface com.sas.PublicClonable- Overrides:
clone in class com.sas.Component
- Returns:
- a clone of the dynamic property bag
- Throws:
java.lang.CloneNotSupportedException - if the object cannot be cloned.
set
public void set(java.lang.String key,
java.lang.Object property)
- Put a property in the property bag.
- Specified by:
set in interface com.sas.collection.PropertyBagInterface
- Parameters:
key - the name of the property.
This string must be
an interned string and may not be null.
(Use aString.intern() to create an interned string.)property - the value to associate with the property name
Property values may be null.
remove
public void remove(java.lang.String key)
- Remove a property from the property bag.
After removing, contains(key) will return false
and get(key) will throw
a NoSuchElementException
- Specified by:
remove in interface com.sas.collection.PropertyBagInterface
- Parameters:
key - the name of the property.
This string must be
an interned string and may not be null.
(Use aString.intern() to create an interned string.)
Throws:
java.util.NoSuchElementException - if the
bag does not contains the named element.
removeAll
public void removeAll()
- Remove all items from the property bag.
- Specified by:
removeAll in interface com.sas.collection.PropertyBagInterface
set
public void set(com.sas.collection.StaticPropertyBagInterface other)
- Add the contents of another property bag to this property bag.
This does set(key, property) on this property bag
for each the key/property pair from the source.
- Specified by:
set in interface com.sas.collection.PropertyBagInterface
- Parameters:
other - another property bag- See Also:
PropertyBagInterface.merge(com.sas.collection.StaticPropertyBagInterface)
merge
public void merge(com.sas.collection.StaticPropertyBagInterface other)
- Merge into this bag any property from the source
which does not exist in this bag. For items which
exists in both property bags, if both items are also
property bags, merge the element from other
into the element from this PropertyBag recursively.
- Specified by:
merge in interface com.sas.collection.PropertyBagInterface
- Parameters:
other - another property bag- See Also:
PropertyBagInterface.set(com.sas.collection.StaticPropertyBagInterface)
addPropertyBagChangedListener
public void addPropertyBagChangedListener(com.sas.collection.PropertyBagChangedListener listener)
- Add a listener for the com.sas.collection.PropertyBagChangedEvent event.
- Specified by:
addPropertyBagChangedListener in interface com.sas.collection.PropertyBagChangedSource
- Parameters:
listener - an object which handles PropertyBagChangedEvent events
the listener is not added a second time if it already exists
in the list of listeners for this event.- See Also:
PropertyBagChangedSource
removePropertyBagChangedListener
public void removePropertyBagChangedListener(com.sas.collection.PropertyBagChangedListener listener)
- Remove a listener for the com.sas.collection.PropertyBagChangedEvent event. Nothing
happens if the listener is not in the list of listeners for this event.
- Specified by:
removePropertyBagChangedListener in interface com.sas.collection.PropertyBagChangedSource
- Parameters:
listener - an object which handles PropertyBagChangedEvent events- See Also:
PropertyBagChangedSource
All Libraries
This Library
Package
Class
Use
Tree
Deprecated
Index
Grand Index
Help
Components
PREV CLASS
NEXT CLASS
FRAMES
NO FRAMES
All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD
DETAIL: FIELD | CONSTR | METHOD
Copyright © 2009 SAS Institute Inc. All Rights Reserved. 