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
 

Constructor Summary

BasicNameValuePair(String name, String value)
Default Constructor taking a name and a value.

Method Summary

Object	clone() Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object object) Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
String	getName() Returns the name.
String	getValue() Returns the value.
int	hashCode() Returns an integer hash code for the receiver.
String	toString() Get a string representation of this pair.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

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 Detail

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 the argument to the receiver, and returns true if they represent the same object using a class specific comparison. The implementation in Object returns true only if the argument is the exact same object as the receiver (==).

Overrides:

equals in class Object

Parameters:

object - Object the object to compare with this object.

Returns:

boolean true if the object is the same as this object false if it is different from this object.

See Also:

Object.hashCode()

hashCode

public int hashCode()

Description copied from class: Object

Returns an integer hash code for the receiver. Any two objects which answer true when passed to .equals must answer the same value for this method.

Overrides:

hashCode in class Object

Returns:

int the receiver's hash.

See Also:

Object.equals(java.lang.Object)

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from class: Object

Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.

Classes which wish to support cloning must specify that they implement the Cloneable interface, since the implementation checks for this.

Overrides:

clone in class Object

Returns:

Object a shallow copy of this object.

Throws:

CloneNotSupportedException - if the receiver's class does not implement the interface Cloneable.