Package org.apache.http.message

Class BasicNameValuePair

java.lang.Object
org.apache.http.message.BasicNameValuePair
All Implemented Interfaces:
Cloneable, NameValuePair
public class BasicNameValuePair
extends Object
implements NameValuePair, Cloneable
A simple class encapsulating an attribute/value pair.

This class comforms to the generic grammar and formatting rules outlined in the Section 2.2 and Section 3.6 of RFC 2616

2.2 Basic Rules

The following rules are used throughout this specification to describe basic parsing constructs. The US-ASCII coded character set is defined by ANSI X3.4-1986. 

     OCTET          = 
     CHAR           = 
     UPALPHA        = 
     LOALPHA        = 
     ALPHA          = UPALPHA | LOALPHA
     DIGIT          = 
     CTL            = 
     CR             = 
     LF             = 
     SP             = 
     HT             = 
     <">            =

Many HTTP/1.1 header field values consist of words separated by LWS or special characters. These special characters MUST be in a quoted string to be used within a parameter value (as defined in section 3.6). 

 token          = 1*
 separators     = "(" | ")" | "<" | ">" | "@"
                | "," | ";" | ":" | "\" | <">
                | "/" | "[" | "]" | "?" | "="
                | "{" | "}" | SP | HT

A string of text is parsed as a single word if it is quoted using double-quote marks. 

 quoted-string  = ( <"> *(qdtext | quoted-pair ) <"> )
 qdtext         = >

The backslash character ("\") MAY be used as a single-character quoting mechanism only within quoted-string and comment constructs. 

 quoted-pair    = "\" CHAR
3.6 Transfer Codings

Parameters are in the form of attribute/value pairs. 

 parameter               = attribute "=" value
 attribute               = token
 value                   = token | quoted-string
Author:
Oleg Kalnichevski

  • Constructor Details

    • BasicNameValuePair

      public BasicNameValuePair​(String name, String value)
      Default Constructor taking a name and a value. The value may be null.
      Parameters:
      name - The name.
      value - The value.

  • Method Details

    • getName

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

    • getValue

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

    • toString

      public String toString()
      Get a string representation of this pair.
      Overrides:
      toString in class Object
      Returns:
      A string representation.

    • 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)

    • 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.