public class

BasicNameValuePair

extends Object
implements Cloneable NameValuePair
java.lang.Object
   ↳ org.apache.http.message.BasicNameValuePair

Class Overview

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

Summary

Public Constructors
BasicNameValuePair(String name, String value)
Default Constructor taking a name and a value.
Public Methods
Object clone()
Creates and returns a copy of this Object.
boolean equals(Object object)
Compares this instance with the specified object and indicates if they are equal.
String getName()
Returns the name.
String getValue()
Returns the value.
int hashCode()
Returns an integer hash code for this object.
String toString()
Get a string representation of this pair.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.http.NameValuePair

Public Constructors

public BasicNameValuePair (String name, String value)

Since: API Level 1

Default Constructor taking a name and a value. The value may be null.

Parameters
name The name.
value The value.

Public Methods

public Object clone ()

Since: API Level 1

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.

Returns
  • a copy of this object.
Throws
CloneNotSupportedException

public boolean equals (Object object)

Since: API Level 1

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 both transitive and reflexive.

The implementation in Object returns true only if o is the exact same object as the receiver (using the == operator for comparison). Subclasses often implement equals(Object) so that it takes into account the two object's types and states.

The general contract for the equals(Object) and 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 none of them.

Parameters
object the object to compare this instance with.
Returns
  • true if the specified object is equal to this Object; false otherwise.

public String getName ()

Since: API Level 1

Returns the name.

Returns
  • String name The name

public String getValue ()

Since: API Level 1

Returns the value.

Returns
  • String value The current value.

public int hashCode ()

Since: API Level 1

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Returns
  • this object's hash code.

public String toString ()

Since: API Level 1

Get a string representation of this pair.

Returns
  • A string representation.