Top Description Methods
org.apache.http

public Interface HeaderElement

Known Direct Implementers
org.apache.http.message.BasicHeaderElement

One element of an HTTP header value consisting of a name / value pair and a number of optional name / value parameters.

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 String; if the "=" is also missing null will be stored instead.

Since
4.0

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

header element name
getName
()

Returns header element name.

public NameValuePair

Returns:

name / value pair
getParameter
(int
index
index
)

Returns parameter with the given index.

public NameValuePair

Returns:

name / value pair
getParameterByName
(String
parameter name
name
)

Returns the first parameter with the given name.

public int

Returns:

parameter count
getParameterCount
()

Returns the total count of parameters.

public NameValuePair[]

Returns:

array of name / value pairs
getParameters
()

Returns an array of name / value pairs.

public String

Returns:

header element value
getValue
()

Returns header element value.

Method Detail

getNameback to summary
public String getName()

Returns header element name.

Returns:String

header element name

getParameterback to summary
public NameValuePair getParameter(int index)

Returns parameter with the given index.

Parameters
index:int

index

Returns:NameValuePair

name / value pair

getParameterByNameback to summary
public NameValuePair getParameterByName(String name)

Returns the first parameter with the given name.

Parameters
name:String

parameter name

Returns:NameValuePair

name / value pair

getParameterCountback to summary
public int getParameterCount()

Returns the total count of parameters.

Returns:int

parameter count

getParametersback to summary
public NameValuePair[] getParameters()

Returns an array of name / value pairs.

Returns:NameValuePair[]

array of name / value pairs

getValueback to summary
public String getValue()

Returns header element value.

Returns:String

header element value