org.apache.http.message
Class BasicNameValuePair

java.lang.Object
  extended by org.apache.http.message.BasicNameValuePair
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, NameValuePair

public class BasicNameValuePair
extends java.lang.Object
implements NameValuePair, java.lang.Cloneable, java.io.Serializable

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
See Also:
Serialized Form

Constructor Summary
BasicNameValuePair(java.lang.String name, java.lang.String value)
          Default Constructor taking a name and a value.
 
Method Summary
 java.lang.Object clone()
           
 boolean equals(java.lang.Object object)
           
 java.lang.String getName()
          Returns the name.
 java.lang.String getValue()
          Returns the value.
 int hashCode()
           
 java.lang.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(java.lang.String name,
                          java.lang.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 java.lang.String getName()
Returns the name.

Specified by:
getName in interface NameValuePair
Returns:
String name The name

getValue

public java.lang.String getValue()
Returns the value.

Specified by:
getValue in interface NameValuePair
Returns:
String value The current value.

toString

public java.lang.String toString()
Get a string representation of this pair.

Overrides:
toString in class java.lang.Object
Returns:
A string representation.

equals

public boolean equals(java.lang.Object object)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Overrides:
clone in class java.lang.Object
Throws:
java.lang.CloneNotSupportedException


Copyright © 2005-2008 Apache Software Foundation. All Rights Reserved.