Package org.apache.http.message

Class BasicHeaderElement

java.lang.Object
org.apache.http.message.BasicHeaderElement
All Implemented Interfaces:
Cloneable, HeaderElement
public class BasicHeaderElement
extends Object
implements HeaderElement, Cloneable
One element of an HTTP header's value.

Some HTTP headers (such as the set-cookie header) have values that can be decomposed into multiple elements. Such headers must be in the following form: 

 header  = [ element ] *( "," [ element ] )
 element = name [ "=" [ value ] ] *( ";" [ param ] )
 param   = name [ "=" [ value ] ]

 name    = token
 value   = ( token | quoted-string )

 token         = 1*<any char except "=", ",", ";", <"> and
                       white space>
 quoted-string = <"> *( text | quoted-char ) <">
 text          = any char except <">
 quoted-char   = "\" char

Any amount of white space is allowed between any part of the header, element or param and is ignored. A missing value in any element or param will be stored as the empty String; if the "=" is also missing null will be stored instead.

This class represents an individual header element, containing both a name/value pair (value may be null) and optionally a set of additional parameters.

Since:
4.0
Version:
$Revision: 604625 $ $Date: 2007-12-16 06:11:11 -0800 (Sun, 16 Dec 2007) $
Author:
B.C. Holmes, Park, Sung-Gu, Mike Bowler, Oleg Kalnichevski

  • Constructor Details

    • BasicHeaderElement

      public BasicHeaderElement​(String name, String value, NameValuePair[] parameters)
      Constructor with name, value and parameters.
      Parameters:
      name - header element name
      value - header element value. May be null
      parameters - header element parameters. May be null. Parameters are copied by reference, not by value

    • BasicHeaderElement

      public BasicHeaderElement​(String name, String value)
      Constructor with name and value.
      Parameters:
      name - header element name
      value - header element value. May be null

  • Method Details

    • getName

      public String getName()
      Returns the name.
      Specified by:
      getName in interface HeaderElement
      Returns:
      String name The name

    • getValue

      public String getValue()
      Returns the value.
      Specified by:
      getValue in interface HeaderElement
      Returns:
      String value The current value.

    • getParameters

      public NameValuePair[] getParameters()
      Get parameters, if any. The returned array is created for each invocation and can be modified by the caller without affecting this header element.
      Specified by:
      getParameters in interface HeaderElement
      Returns:
      parameters as an array of NameValuePairs

    • getParameterCount

      public int getParameterCount()
      Obtains the number of parameters.
      Specified by:
      getParameterCount in interface HeaderElement
      Returns:
      the number of parameters

    • getParameter

      public NameValuePair getParameter​(int index)
      Obtains the parameter with the given index.
      Specified by:
      getParameter in interface HeaderElement
      Parameters:
      index - the index of the parameter, 0-based
      Returns:
      the parameter with the given index

    • getParameterByName

      public NameValuePair getParameterByName​(String name)
      Returns parameter with the given name, if found. Otherwise null is returned
      Specified by:
      getParameterByName in interface HeaderElement
      Parameters:
      name - The name to search by.
      Returns:
      NameValuePair parameter with the given name

    • equals

      public boolean equals​(Object object)
      Description copied from class: Object
      Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

      The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

      The general contract for the equals and Object.hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

      Overrides:
      equals in class Object
      Parameters:
      object - the object to compare this instance with.
      Returns:
      true if the specified object is equal to this Object; false otherwise.
      See Also:
      Object.hashCode()

    • hashCode

      public int hashCode()
      Description copied from class: Object
      Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

      Note that hash values must not change over time unless information used in equals comparisons also changes.

      See Writing a correct hashCode method if you intend implementing your own hashCode method.

      Overrides:
      hashCode in class Object
      Returns:
      this object's hash code.
      See Also:
      Object.equals(java.lang.Object)

    • toString

      public String toString()
      Description copied from class: Object
      Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression: 
         getClass().getName() + '@' + Integer.toHexString(hashCode())

      See Writing a useful toString method if you intend implementing your own toString method.

      Overrides:
      toString in class Object
      Returns:
      a printable representation of this object.

    • clone

      public Object clone() throws CloneNotSupportedException
      Description copied from class: Object
      Creates and returns a copy of this Object. The default implementation returns a so-called "shallow" copy: It creates a new instance of the same class and then copies the field values (including object references) from this instance to the new instance. A "deep" copy, in contrast, would also recursively clone nested objects. A subclass that needs to implement this kind of cloning should call super.clone() to create the new instance and then create deep copies of the nested, mutable objects.
      Overrides:
      clone in class Object
      Returns:
      a copy of this object.
      Throws:
      CloneNotSupportedException - if this object's class does not implement the Cloneable interface.