FileDocCategorySizeDatePackage
BasicNameValuePair.javaAPI DocAndroid 1.5 API6404Wed May 06 22:41:10 BST 2009org.apache.http.message

BasicNameValuePair

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

Fields Summary
private final String
name
private final String
value
Constructors Summary
public BasicNameValuePair(String name, String value)
Default Constructor taking a name and a value. The value may be null.

param
name The name.
param
value The value.

        super();
        if (name == null) {
            throw new IllegalArgumentException("Name may not be null");
        }
        this.name = name;
        this.value = value;
Methods Summary
public java.lang.Objectclone()

        return super.clone();
public booleanequals(java.lang.Object object)

        if (object == null) return false;
        if (this == object) return true;
        if (object instanceof NameValuePair) {
            BasicNameValuePair that = (BasicNameValuePair) object;
            return this.name.equals(that.name)
                  && LangUtils.equals(this.value, that.value);
        } else {
            return false;
        }
public java.lang.StringgetName()
Returns the name.

return
String name The name

        return this.name;
public java.lang.StringgetValue()
Returns the value.

return
String value The current value.

        return this.value;
public inthashCode()

        int hash = LangUtils.HASH_SEED;
        hash = LangUtils.hashCode(hash, this.name);
        hash = LangUtils.hashCode(hash, this.value);
        return hash;
public java.lang.StringtoString()
Get a string representation of this pair.

return
A string representation.

        // don't call complex default formatting for a simple toString

        int len = this.name.length();
        if (this.value != null)
            len += 1 + this.value.length();
        CharArrayBuffer buffer = new CharArrayBuffer(len);

        buffer.append(this.name);
        if (this.value != null) {
            buffer.append("=");
            buffer.append(this.value);
        }
        return buffer.toString();