Package b4j.util

Class UrlParameters

java.lang.Object
b4j.util.UrlParameters
public class UrlParameters
extends java.lang.Object
Collects information about URL parameters. The object can be used to produce the URL-encoded-scheme form of parameters. It supports multiple values per parameter.
Author:
Ralph Schuster

  • Constructor Summary

    Constructors 
    Constructor Description
    UrlParameters()
    Default constructor.

  • Method Summary

    Modifier and Type Method Description
    void addAll​(java.lang.String key, java.util.List<java.lang.String> values)
    Adds all values of a parameter.
    void addAll​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> p)
    Adds all parameters.
    void addDefaultParameters​(UrlParameters defaults)
    Adds default parameters.
    static UrlParameters createUrlParameters​(SearchData searchData)
    Creates URL parameters out of the Bugzilla search data.
    java.util.List<java.lang.String> getParameter​(java.lang.String key)
    Returns a list of all values of this parameter (or null)
    java.util.Iterator<java.lang.String> getParameters()
    Returns iterator of all parameter names.
    java.lang.String getUrlEncodedString()
    Returns the URL encoded string of this parameters.
    static java.lang.String getUrlEncodedString​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> parameters)
    Returns the URL encoded string of the parameters.
    void removeParameter​(java.lang.String key)
    Removes a parameter.
    void removeParameter​(java.lang.String key, java.lang.String value)
    Removes a value from a parameter.
    void setParameter​(java.lang.String key, java.lang.String value)
    Sets a specific parameter.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • setParameter

      public void setParameter​(java.lang.String key, java.lang.String value)
      Sets a specific parameter. Actually just adds it.
      Parameters:
      key - - name of parameter
      value - - value to add

    • getParameter

      public java.util.List<java.lang.String> getParameter​(java.lang.String key)
      Returns a list of all values of this parameter (or null)
      Parameters:
      key - - name of parameter
      Returns:
      list of values for this parameter

    • getParameters

      public java.util.Iterator<java.lang.String> getParameters()
      Returns iterator of all parameter names.
      Returns:
      iterator on all parameter names

    • addAll

      public void addAll​(java.lang.String key, java.util.List<java.lang.String> values)
      Adds all values of a parameter.
      Parameters:
      key - - name of parameter
      values - - values to add

    • addAll

      public void addAll​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> p)
      Adds all parameters.
      Parameters:
      p - - list of parameters

    • removeParameter

      public void removeParameter​(java.lang.String key, java.lang.String value)
      Removes a value from a parameter.
      Parameters:
      key - - name of parameter
      value - - value to remove

    • removeParameter

      public void removeParameter​(java.lang.String key)
      Removes a parameter.
      Parameters:
      key - - parameter to remove

    • getUrlEncodedString

      public java.lang.String getUrlEncodedString()
      Returns the URL encoded string of this parameters.
      Returns:
      the URL encoded string of the parameters

    • addDefaultParameters

      public void addDefaultParameters​(UrlParameters defaults)
      Adds default parameters. Only thos parameters will be applied that are not set yet.
      Parameters:
      defaults - - default parameters to apply.

    • createUrlParameters

      public static UrlParameters createUrlParameters​(SearchData searchData)
      Creates URL parameters out of the Bugzilla search data. This method returns an UrlParameters object created from the search parameters and their respective values.
      Parameters:
      searchData - - the search data to transform
      Returns:
      URL parameters object

    • getUrlEncodedString

      public static java.lang.String getUrlEncodedString​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> parameters)
      Returns the URL encoded string of the parameters.
      Parameters:
      parameters - - parameter list
      Returns:
      URL encoded string