Package org.apache.http.params

Interface HttpParams

All Known Implementing Classes:
AbstractHttpParams, BasicHttpParams, ClientParamsStack, DefaultedHttpParams
public interface HttpParams
Represents a collection of HTTP protocol and framework parameters.
Since:
4.0
Version:
$Revision: 610763 $
Author:
Oleg Kalnichevski

  • Method Details

    • getParameter

      Object getParameter​(String name)
      Obtains the value of the given parameter.
      Parameters:
      name - the parent name.
      Returns:
      an object that represents the value of the parameter, null if the parameter is not set or if it is explicitly set to null
      See Also:
      setParameter(String, Object)

    • setParameter

      HttpParams setParameter​(String name, Object value)
      Assigns the value to the parameter with the given name.
      Parameters:
      name - parameter name
      value - parameter value

    • copy

      HttpParams copy()
      Creates a copy of these parameters.
      Returns:
      a new set of parameters holding the same values as this one

    • removeParameter

      boolean removeParameter​(String name)
      Removes the parameter with the specified name.
      Parameters:
      name - parameter name
      Returns:
      true if the parameter existed and has been removed, false else.

    • getLongParameter

      long getLongParameter​(String name, long defaultValue)
      Returns a Long parameter value with the given name. If the parameter is not explicitly set, the default value is returned.
      Parameters:
      name - the parent name.
      defaultValue - the default value.
      Returns:
      a Long that represents the value of the parameter.
      See Also:
      setLongParameter(String, long)

    • setLongParameter

      HttpParams setLongParameter​(String name, long value)
      Assigns a Long to the parameter with the given name
      Parameters:
      name - parameter name
      value - parameter value

    • getIntParameter

      int getIntParameter​(String name, int defaultValue)
      Returns an Integer parameter value with the given name. If the parameter is not explicitly set, the default value is returned.
      Parameters:
      name - the parent name.
      defaultValue - the default value.
      Returns:
      a Integer that represents the value of the parameter.
      See Also:
      setIntParameter(String, int)

    • setIntParameter

      HttpParams setIntParameter​(String name, int value)
      Assigns an Integer to the parameter with the given name
      Parameters:
      name - parameter name
      value - parameter value

    • getDoubleParameter

      double getDoubleParameter​(String name, double defaultValue)
      Returns a Double parameter value with the given name. If the parameter is not explicitly set, the default value is returned.
      Parameters:
      name - the parent name.
      defaultValue - the default value.
      Returns:
      a Double that represents the value of the parameter.
      See Also:
      setDoubleParameter(String, double)

    • setDoubleParameter

      HttpParams setDoubleParameter​(String name, double value)
      Assigns a Double to the parameter with the given name
      Parameters:
      name - parameter name
      value - parameter value

    • getBooleanParameter

      boolean getBooleanParameter​(String name, boolean defaultValue)
      Returns a Boolean parameter value with the given name. If the parameter is not explicitly set, the default value is returned.
      Parameters:
      name - the parent name.
      defaultValue - the default value.
      Returns:
      a Boolean that represents the value of the parameter.
      See Also:
      setBooleanParameter(String, boolean)

    • setBooleanParameter

      HttpParams setBooleanParameter​(String name, boolean value)
      Assigns a Boolean to the parameter with the given name
      Parameters:
      name - parameter name
      value - parameter value

    • isParameterTrue

      boolean isParameterTrue​(String name)
      Checks if a boolean parameter is set to true.
      Parameters:
      name - parameter name
      Returns:
      true if the parameter is set to value true, false if it is not set or set to false

    • isParameterFalse

      boolean isParameterFalse​(String name)
      Checks if a boolean parameter is not set or false.
      Parameters:
      name - parameter name
      Returns:
      true if the parameter is either not set or set to value false, false if it is set to true