Package org.apache.pivot.web

Class QueryDictionary

  • All Implemented Interfaces:
    java.lang.Iterable<java.lang.String>, Dictionary<java.lang.String,​java.lang.String>
    public final class QueryDictionary
extends java.lang.Object
implements Dictionary<java.lang.String,​java.lang.String>, java.lang.Iterable<java.lang.String>
    Represents a collection of keyed data associated with a query. Allows multiple values to be set against a given key.

    • Constructor Summary

      Constructors 
      Constructor Description
      QueryDictionary​(boolean caseSensitiveKeys)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int add​(java.lang.String key, java.lang.String value)  
      void clear()  
      boolean containsKey​(java.lang.String key)
      Tests the existence of a key in the dictionary.
      java.lang.String get​(java.lang.String key)
      Retrieves the value for the given key.
      java.lang.String get​(java.lang.String key, int index)  
      int getLength​(java.lang.String key)  
      void insert​(java.lang.String key, java.lang.String value, int index)  
      java.util.Iterator<java.lang.String> iterator()  
      java.lang.String put​(java.lang.String key, java.lang.String value)
      Sets the value of the given key, creating a new entry or replacing the existing value.
      java.lang.String remove​(java.lang.String key)
      Removes a key/value pair from the map.
      java.lang.String remove​(java.lang.String key, int index)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Constructor Detail

      • QueryDictionary

        public QueryDictionary​(boolean caseSensitiveKeys)

    • Method Detail

      • get

        public java.lang.String get​(java.lang.String key)
        Description copied from interface: Dictionary
        Retrieves the value for the given key.
        Specified by:
        get in interface Dictionary<java.lang.String,​java.lang.String>
        Parameters:
        key - The key whose value is to be returned.
        Returns:
        The value corresponding to key, or null if the key does not exist. Will also return null if the key refers to a null value. Use Dictionary.containsKey(K) to distinguish between these two cases.

      • get

        public java.lang.String get​(java.lang.String key,
                            int index)

      • put

        public java.lang.String put​(java.lang.String key,
                            java.lang.String value)
        Description copied from interface: Dictionary
        Sets the value of the given key, creating a new entry or replacing the existing value.
        Specified by:
        put in interface Dictionary<java.lang.String,​java.lang.String>
        Parameters:
        key - The key whose value is to be set.
        value - The value to be associated with the given key.
        Returns:
        The value previously associated with the key.

      • add

        public int add​(java.lang.String key,
               java.lang.String value)

      • insert

        public void insert​(java.lang.String key,
                   java.lang.String value,
                   int index)

      • remove

        public java.lang.String remove​(java.lang.String key)
        Description copied from interface: Dictionary
        Removes a key/value pair from the map.
        Specified by:
        remove in interface Dictionary<java.lang.String,​java.lang.String>
        Parameters:
        key - The key whose mapping is to be removed.
        Returns:
        The value that was removed.

      • remove

        public java.lang.String remove​(java.lang.String key,
                               int index)

      • clear

        public void clear()

      • containsKey

        public boolean containsKey​(java.lang.String key)
        Description copied from interface: Dictionary
        Tests the existence of a key in the dictionary.
        Specified by:
        containsKey in interface Dictionary<java.lang.String,​java.lang.String>
        Parameters:
        key - The key whose presence in the dictionary is to be tested.
        Returns:
        true if the key exists in the dictionary; false, otherwise.

      • getLength

        public int getLength​(java.lang.String key)

      • iterator

        public java.util.Iterator<java.lang.String> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<java.lang.String>