com.neatech.climbplan.simulation
Interface AVList

All Known Implementing Classes:

AVListImpl, Simulation

public interface AVList

An interface for managing an attribute-value pair collection.

Version:

$Id: AVList.java 9428 2009-03-17 07:05:09Z tgaskins $

Author:

Tom Gaskins

Method Summary

void	addPropertyChangeListener(PropertyChangeListener listener) Adds the specified all-property property change listener that will be called for all list changes.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Adds a property change listener for the specified key.
AVList	clearList()
AVList	copy() Returns a shallow copy of this AVList instance: the keys and values themselves are not cloned.
void	firePropertyChange(PropertyChangeEvent propertyChangeEvent) Calls all registered property change listeners with the specified property change event.
void	firePropertyChange(String propertyName, Object oldValue, Object newValue) Calls all property change listeners associated with the specified key.
Set<Map.Entry<String,Object>>	getEntries()
String	getStringValue(String key) Returns the value for a specified key.
Object	getValue(String key) Returns the value for a specified key.
Collection<Object>	getValues()
boolean	hasKey(String key) Indicates whether a key is in the collection.
Object	removeKey(String key) Removes a specified key from the collection if the key exists, otherwise returns without affecting the collection.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes the specified all-property property change listener.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener) Removes a property change listener associated with the specified key.
Object	setValue(String key, Object value) Adds a key/value pair to the list.
AVList	setValues(AVList avList) Adds the contents of another attribute-value list to the list.

Method Detail

setValue

Object setValue(String key,
                Object value)

Adds a key/value pair to the list. Replaces an existing key/value pair if the list already contains the key.

Parameters:

key - the attribute name. May not be null.

value - the attribute value. May be null, in which case any existing value for the key is removed from the collection.

Returns:

previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key, if the implementation supports null values.

Throws:

NullPointerException - if key is null.

setValues

AVList setValues(AVList avList)

Adds the contents of another attribute-value list to the list. Replaces an existing key/value pair if the list already contains the key.

Parameters:

avList - the list to copy. May not be null.

Returns:

this, a self reference.

Throws:

NullPointerException - if avList is null.

getValue

Object getValue(String key)

Returns the value for a specified key.

Parameters:

key - the attribute name. May not be null.

Returns:

the attribute value if one exists in the collection, otherwise null.

Throws:

NullPointerException - if key is null.

getValues

Collection<Object> getValues()

getStringValue

String getStringValue(String key)

Returns the value for a specified key. The value must be a String.

Parameters:

key - the attribute name. May not be null.

Returns:

the attribute value if one exists in the collection, otherwise null.

Throws:

NullPointerException - if key is null.

gov.nasa.worldwind.exception.WWRuntimeException - if the value in the collection is not a String type.

getEntries

Set<Map.Entry<String,Object>> getEntries()

hasKey

boolean hasKey(String key)

Indicates whether a key is in the collection.

Parameters:

key - the attribute name. May not be null.

Returns:

true if the key exists in the collection, otherwise false.

Throws:

NullPointerException - if key is null.

removeKey

Object removeKey(String key)

Removes a specified key from the collection if the key exists, otherwise returns without affecting the collection.

Parameters:

key - the attribute name. May not be null.

Returns:

previous value associated with specified key, or null if there was no mapping for key.

Throws:

NullPointerException - if key is null.

addPropertyChangeListener

void addPropertyChangeListener(String propertyName,
                               PropertyChangeListener listener)

Adds a property change listener for the specified key.

Parameters:

propertyName - the key to associate the listener with.

listener - the listener to associate with the key.

Throws:

IllegalArgumentException - if either propertyName or listener is null

See Also:

PropertyChangeSupport

removePropertyChangeListener

void removePropertyChangeListener(String propertyName,
                                  PropertyChangeListener listener)

Removes a property change listener associated with the specified key.

Parameters:

propertyName - the key associated with the change listener.

listener - the listener to remove.

Throws:

IllegalArgumentException - if either propertyName or listener is null

See Also:

PropertyChangeSupport

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)

Adds the specified all-property property change listener that will be called for all list changes.

Parameters:

listener - the listener to call.

Throws:

IllegalArgumentException - if listener is null

See Also:

PropertyChangeSupport

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)

Removes the specified all-property property change listener.

Parameters:

listener - the listener to remove.

Throws:

IllegalArgumentException - if listener is null

See Also:

PropertyChangeSupport

firePropertyChange

void firePropertyChange(String propertyName,
                        Object oldValue,
                        Object newValue)

Calls all property change listeners associated with the specified key. No listeners are called if odValue and newValue are equal and non-null.

Parameters:

propertyName - the key

oldValue - the value associated with the key before the even causing the firing.

newValue - the new value associated with the key.

Throws:

IllegalArgumentException - if propertyName is null

See Also:

PropertyChangeSupport

firePropertyChange

void firePropertyChange(PropertyChangeEvent propertyChangeEvent)

Calls all registered property change listeners with the specified property change event.

Parameters:

propertyChangeEvent - the event

Throws:

IllegalArgumentException - if propertyChangeEvent is null

See Also:

PropertyChangeSupport

copy

AVList copy()

Returns a shallow copy of this AVList instance: the keys and values themselves are not cloned.

Returns:

a shallow copy of this AVList.

clearList

AVList clearList()