Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> [ http overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.http
Class NameValuePair  

java.lang.Object
  org.apache.http.NameValuePair

---

public class NameValuePair

extends java.lang.Object

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
 

---

Field Summary
private  java.lang.String	name
private static char[]	SEPARATORS           Special characters that can be used as separators in HTTP parameters.
private static char[]	UNSAFE_CHARS           Unsafe special characters that must be escaped using the backslash character
private  java.lang.String	value

 

Constructor Summary

NameValuePair(java.lang.String name, java.lang.String value)           Default Constructor taking a name and a value.

 

Method Summary
boolean	equals(java.lang.Object object)           Determine whether this Object is semantically equal to another Object.
static void	format(org.apache.http.io.CharArrayBuffer buffer, NameValuePair param, boolean alwaysUseQuotes)           Produces textual representaion of the attribute/value pair using formatting rules defined in RFC 2616
private static void	format(org.apache.http.io.CharArrayBuffer buffer, java.lang.String value, boolean alwaysUseQuotes)
static java.lang.String	format(NameValuePair param, boolean alwaysUseQuotes)           Produces textual representaion of the attribute/value pair using formatting rules defined in RFC 2616
static void	formatAll(org.apache.http.io.CharArrayBuffer buffer, NameValuePair[] params, boolean alwaysUseQuotes)           Produces textual representaion of the attribute/value pairs using formatting rules defined in RFC 2616
static java.lang.String	formatAll(NameValuePair[] params, boolean alwaysUseQuotes)           Produces textual representaion of the attribute/value pair using formatting rules defined in RFC 2616
java.lang.String	getName()           Returns the name.
java.lang.String	getValue()           Returns the value.
int	hashCode()           Get a value that represents this Object, as uniquely as possible within the confines of an int.
private static boolean	isOneOf(char[] chars, char ch)
private static boolean	isSeparator(char ch)
private static boolean	isUnsafeChar(char ch)
static NameValuePair	parse(org.apache.http.io.CharArrayBuffer buffer, int indexFrom, int indexTo)
static NameValuePair	parse(java.lang.String s)
static NameValuePair[]	parseAll(org.apache.http.io.CharArrayBuffer buffer, int indexFrom, int indexTo)
static NameValuePair[]	parseAll(java.lang.String s)
java.lang.String	toString()           Get a string representation of this pair.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

name

private final java.lang.String name

---

value

private final java.lang.String value

---

SEPARATORS

private static final char[] SEPARATORS

Special characters that can be used as separators in HTTP parameters. These special characters MUST be in a quoted string to be used within a parameter value

---

UNSAFE_CHARS

private static final char[] UNSAFE_CHARS

Unsafe special characters that must be escaped using the backslash character

Constructor Detail

NameValuePair

public NameValuePair(java.lang.String name,
                     java.lang.String value)

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

Method Detail

getName

public java.lang.String getName()

Returns the name.

---

getValue

public java.lang.String getValue()

Returns the value.

---

parseAll

public static final NameValuePair[] parseAll(org.apache.http.io.CharArrayBuffer buffer,
                                             int indexFrom,
                                             int indexTo)

---

parseAll

public static final NameValuePair[] parseAll(java.lang.String s)

---

parse

public static NameValuePair parse(org.apache.http.io.CharArrayBuffer buffer,
                                  int indexFrom,
                                  int indexTo)

---

parse

public static final NameValuePair parse(java.lang.String s)

---

isOneOf

private static boolean isOneOf(char[] chars,
                               char ch)

---

isUnsafeChar

private static boolean isUnsafeChar(char ch)

---

isSeparator

private static boolean isSeparator(char ch)

---

format

private static void format(org.apache.http.io.CharArrayBuffer buffer,
                           java.lang.String value,
                           boolean alwaysUseQuotes)

---

format

public static void format(org.apache.http.io.CharArrayBuffer buffer,
                          NameValuePair param,
                          boolean alwaysUseQuotes)

Produces textual representaion of the attribute/value pair using formatting rules defined in RFC 2616

---

formatAll

public static void formatAll(org.apache.http.io.CharArrayBuffer buffer,
                             NameValuePair[] params,
                             boolean alwaysUseQuotes)

Produces textual representaion of the attribute/value pairs using formatting rules defined in RFC 2616

---

format

public static java.lang.String format(NameValuePair param,
                                      boolean alwaysUseQuotes)

Produces textual representaion of the attribute/value pair using formatting rules defined in RFC 2616

---

formatAll

public static java.lang.String formatAll(NameValuePair[] params,
                                         boolean alwaysUseQuotes)

Produces textual representaion of the attribute/value pair using formatting rules defined in RFC 2616

---

toString

public java.lang.String toString()

Get a string representation of this pair.

---

equals

public boolean equals(java.lang.Object object)

Description copied from class: java.lang.Object

Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

• It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
• It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
• It must be reflexive. a.equals(a) must always be true.
• It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
• a.equals(null) must be false.
• It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

---

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

• Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
• It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> [ http overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---