gov/nasa/worldwind/avlist/AVList.java

   1 /*
   2 Copyright (C) 2001, 2006 United States Government
   3 as represented by the Administrator of the
   4 National Aeronautics and Space Administration.
   5 All Rights Reserved.
   6 */
   7 package gov.nasa.worldwind.avlist;
   8
   9 import java.util.*;
  10
  11 /**
  12  * An interface for managing an attribute-value pair collection.
  13  *
  14  * @author Tom Gaskins
  15  * @version $Id: AVList.java 2422 2007-07-25 23:07:49Z tgaskins $
  16  */
  17 public interface AVList
  18 {
  19     /**
  20      * Adds a key/value pair to the list. Replaces an existing key/value pair if the list already contains the key.
  21      *
  22      * @param key   the attribute name. May not be <code>null</code>.
  23      * @param value the attribute value. May be <code>null</code>, in which case any existing value for the key is
  24      *              removed from the collection.
  25      * @throws NullPointerException if <code>key</code> is <code>null</code>.
  26      */
  27     void setValue(String key, Object value);
  28
  29     void setValues(AVList avList);
  30
  31     /**
  32      * Returns the value for a specified key.
  33      *
  34      * @param key the attribute name. May not be <code>null</code>.
  35      * @return the attribute value if one exists in the collection, otherwise <code>null</code>.
  36      * @throws NullPointerException if <code>key</code> is <code>null</code>.
  37      */
  38     Object getValue(String key);
  39
  40     Collection<Object> getValues();
  41
  42     /**
  43      * Returns the value for a specified key. The value must be a {@link String}.
  44      *
  45      * @param key the attribute name. May not be <code>null</code>.
  46      * @return the attribute value if one exists in the collection, otherwise <code>null</code>.
  47      * @throws NullPointerException if <code>key</code> is <code>null</code>.
  48      * @throws gov.nasa.worldwind.exception.WWRuntimeException   if the value in the collection is not a <code>String</code> type.
  49      */
  50     String getStringValue(String key);
  51
  52     Set<Map.Entry<String, Object>> getEntries();
  53
  54     /**
  55      * Indicates whether a key is in the collection.
  56      *
  57      * @param key the attribute name. May not be <code>null</code>.
  58      * @return <code>true</code> if the key exists in the collection, otherwise <code>false</code>.
  59      * @throws NullPointerException if <code>key</code> is <code>null</code>.
  60      */
  61     boolean hasKey(String key);
  62
  63     /**
  64      * Removes a specified key from the collection if the key exists, otherwise returns without affecting the
  65      * collection.
  66      *
  67      * @param key the attribute name. May not be <code>null</code>.
  68      * @throws NullPointerException if <code>key</code> is <code>null</code>.
  69      */
  70     void removeKey(String key);
  71
  72     /**
  73      * Adds a property change listener for the specified key.
  74      * @param propertyName the key to associate the listener with.
  75      * @param listener the listener to associate with the key.
  76      * @throws IllegalArgumentException if either <code>propertyName</code> or <code>listener</code> is null
  77      * @see java.beans.PropertyChangeSupport
  78      */
  79     void addPropertyChangeListener(String propertyName, java.beans.PropertyChangeListener listener);
  80
  81     /**
  82      * Removes a property change listener associated with the specified key.
  83      * @param propertyName the key associated with the change listener.
  84      * @param listener the listener to remove.
  85      * @throws IllegalArgumentException if either <code>propertyName</code> or <code>listener</code> is null
  86      * @see java.beans.PropertyChangeSupport
  87      */
  88     void removePropertyChangeListener(String propertyName, java.beans.PropertyChangeListener listener);
  89
  90     /**
  91      * Adds the specified all-property property change listener that will be called for all list changes.
  92      * @param listener the listener to call.
  93      * @throws IllegalArgumentException if <code>listener</code> is null
  94      * @see java.beans.PropertyChangeSupport
  95      */
  96     void addPropertyChangeListener(java.beans.PropertyChangeListener listener);
  97
  98     /**
  99      * Removes the specified all-property property change listener.
 100      * @param listener the listener to remove.
 101      * @throws IllegalArgumentException if <code>listener</code> is null
 102      * @see java.beans.PropertyChangeSupport
 103      */
 104     void removePropertyChangeListener(java.beans.PropertyChangeListener listener);
 105
 106     /**
 107      * Calls all property change listeners associated with the specified key.
 108      * No listeners are called if <code>odValue</code> and <code>newValue</code> are equal and non-null.
 109      * @param propertyName the key
 110      * @param oldValue the value associated with the key before the even causing the firing.
 111      * @param newValue the new value associated with the key.
 112      * @throws IllegalArgumentException if <code>propertyName</code> is null
 113      * @see java.beans.PropertyChangeSupport
 114      */
 115     void firePropertyChange(String propertyName, Object oldValue, Object newValue);
 116
 117     /**
 118      * Calls all registered property change listeners with the specified property change event.
 119      * @param propertyChangeEvent the event
 120      * @throws IllegalArgumentException if <code>propertyChangeEvent</code> is null
 121      * @see java.beans.PropertyChangeSupport
 122      */
 123     void firePropertyChange(java.beans.PropertyChangeEvent propertyChangeEvent);
 124
 125     /**
 126      * Returns a shallow copy of this <code>AVList</code> instance: the keys and values themselves are not cloned.
 127      * @return a shallow copy of this <code>AVList</code>.
 128      */
 129     AVList copy();
 130
 131     AVList clearList();
 132 }