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 HeaderElement  

java.lang.Object
  org.apache.http.HeaderElement

---

public class HeaderElement

extends java.lang.Object

One element of an HTTP header's value.

Some HTTP headers (such as the set-cookie header) have values that can be decomposed into multiple elements. Such headers must be in the following form:

 header  = [ element ] *( "," [ element ] )
 element = name [ "=" [ value ] ] *( ";" [ param ] )
 param   = name [ "=" [ value ] ]

 name    = token
 value   = ( token | quoted-string )

 token         = 1*<any char except "=", ",", ";", <"> and
                       white space>
 quoted-string = <"> *( text | quoted-char ) <">
 text          = any char except <">
 quoted-char   = "\" char
 

Any amount of white space is allowed between any part of the header, element or param and is ignored. A missing value in any element or param will be stored as the empty java.lang.String; if the "=" is also missing null will be stored instead.

This class represents an individual header element, containing both a name/value pair (value may be null) and optionally a set of additional parameters.

This class also exposes a parse(org.apache.http.io.CharArrayBuffer, int, int) 55 method for parsing a Header value into an array of elements.

Since:

1.0

Version:

$Revision: 409980 $ $Date: 2006-05-28 21:45:06 +0200 (Sun, 28 May 2006) $

---

Field Summary
private  java.lang.String	name
private  NameValuePair[]	parameters
private  java.lang.String	value

 

Constructor Summary
private	HeaderElement(NameValuePair[] nvps)
	HeaderElement(java.lang.String name, java.lang.String value)           Constructor with name and value.
	HeaderElement(java.lang.String name, java.lang.String value, NameValuePair[] parameters)           Constructor with name, value and parameters.

 

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, HeaderElement element)
static java.lang.String	format(HeaderElement element)
static void	formatAll(org.apache.http.io.CharArrayBuffer buffer, HeaderElement[] elements)
static java.lang.String	formatAll(HeaderElement[] elements)
java.lang.String	getName()           Returns the name.
NameValuePair	getParameterByName(java.lang.String name)           Returns parameter with the given name, if found.
NameValuePair[]	getParameters()           Get parameters, if any.
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.
static HeaderElement	parse(org.apache.http.io.CharArrayBuffer buffer, int indexFrom, int indexTo)
static HeaderElement	parse(java.lang.String s)
static HeaderElement[]	parseAll(org.apache.http.io.CharArrayBuffer buffer, int indexFrom, int indexTo)           This parses the value part of a header.
static HeaderElement[]	parseAll(java.lang.String s)           This parses the value part of a header.
java.lang.String	toString()           Convert this Object to a human-readable String.

 

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

---

parameters

private final NameValuePair[] parameters

Constructor Detail

HeaderElement

private HeaderElement(NameValuePair[] nvps)

---

HeaderElement

public HeaderElement(java.lang.String name,
                     java.lang.String value,
                     NameValuePair[] parameters)

Constructor with name, value and parameters.

---

HeaderElement

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

Constructor with name and value.

Method Detail

getName

public java.lang.String getName()

Returns the name.

---

getValue

public java.lang.String getValue()

Returns the value.

---

getParameters

public NameValuePair[] getParameters()

Get parameters, if any.

Since:

2.0

---

parseAll

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

This parses the value part of a header. The result is an array of HeaderElement objects.

Since:

3.0

---

parseAll

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

This parses the value part of a header. The result is an array of HeaderElement objects.

Since:

3.0

---

parse

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

---

parse

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

---

format

public static void format(org.apache.http.io.CharArrayBuffer buffer,
                          HeaderElement element)

---

format

public static java.lang.String format(HeaderElement element)

---

formatAll

public static void formatAll(org.apache.http.io.CharArrayBuffer buffer,
                             HeaderElement[] elements)

---

formatAll

public static java.lang.String formatAll(HeaderElement[] elements)

---

getParameterByName

public NameValuePair getParameterByName(java.lang.String name)

Returns parameter with the given name, if found. Otherwise null is returned

---

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)

---

toString

public java.lang.String toString()

Description copied from class: java.lang.Object

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

---

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

---