public abstract class

AbstractHttpMessage

extends Object
implements HttpMessage
java.lang.Object
   ↳ org.apache.http.message.AbstractHttpMessage
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Basic implementation of an HTTP message that can be modified.

Summary

Fields
protected HeaderGroup headergroup
protected HttpParams params
Protected Constructors
AbstractHttpMessage(HttpParams params)
AbstractHttpMessage()
Public Methods
void addHeader(String name, String value)
Adds a header to this message.
void addHeader(Header header)
Adds a header to this message.
boolean containsHeader(String name)
Checks if a certain header is present in this message.
Header[] getAllHeaders()
Returns all the headers of this message.
Header getFirstHeader(String name)
Returns the first header with a specified name of this message.
Header[] getHeaders(String name)
Returns all the headers with a specified name of this message.
Header getLastHeader(String name)
Returns the last header with a specified name of this message.
HttpParams getParams()
Returns the parameters effective for this message as set by setParams(HttpParams).
HeaderIterator headerIterator(String name)
Returns an iterator of the headers with a given name.
HeaderIterator headerIterator()
Returns an iterator of all the headers.
void removeHeader(Header header)
Removes a header from this message.
void removeHeaders(String name)
Removes all headers with a certain name from this message.
void setHeader(Header header)
Overwrites the first header with the same name.
void setHeader(String name, String value)
Overwrites the first header with the same name.
void setHeaders(Header[] headers)
Overwrites all the headers in the message.
void setParams(HttpParams params)
Provides parameters to be used for the processing of this message.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.http.HttpMessage

Fields

protected HeaderGroup headergroup

Since: API Level 1

protected HttpParams params

Since: API Level 1

Protected Constructors

protected AbstractHttpMessage (HttpParams params)

Since: API Level 1

protected AbstractHttpMessage ()

Since: API Level 1

Public Methods

public void addHeader (String name, String value)

Since: API Level 1

Adds a header to this message. The header will be appended to the end of the list.

Parameters
name the name of the header.
value the value of the header.

public void addHeader (Header header)

Since: API Level 1

Adds a header to this message. The header will be appended to the end of the list.

Parameters
header the header to append.

public boolean containsHeader (String name)

Since: API Level 1

Checks if a certain header is present in this message. Header values are ignored.

Parameters
name the header name to check for.
Returns
  • true if at least one header with this name is present.

public Header[] getAllHeaders ()

Since: API Level 1

Returns all the headers of this message. Headers are orderd in the sequence they will be sent over a connection.

Returns
  • all the headers of this message

public Header getFirstHeader (String name)

Since: API Level 1

Returns the first header with a specified name of this message. Header values are ignored. If there is more than one matching header in the message the first element of getHeaders(String) is returned. If there is no matching header in the message null is returned.

Parameters
name the name of the header to return.
Returns
  • the first header whose name property equals name or null if no such header could be found.

public Header[] getHeaders (String name)

Since: API Level 1

Returns all the headers with a specified name of this message. Header values are ignored. Headers are orderd in the sequence they will be sent over a connection.

Parameters
name the name of the headers to return.
Returns
  • the headers whose name property equals name.

public Header getLastHeader (String name)

Since: API Level 1

Returns the last header with a specified name of this message. Header values are ignored. If there is more than one matching header in the message the last element of getHeaders(String) is returned. If there is no matching header in the message null is returned.

Parameters
name the name of the header to return.
Returns
  • the last header whose name property equals name. or null if no such header could be found.

public HttpParams getParams ()

Since: API Level 1

Returns the parameters effective for this message as set by setParams(HttpParams).

public HeaderIterator headerIterator (String name)

Since: API Level 1

Returns an iterator of the headers with a given name.

Parameters
name the name of the headers over which to iterate, or null for all headers
Returns
  • Iterator that returns Header objects with the argument name in the sequence they are sent over a connection.

public HeaderIterator headerIterator ()

Since: API Level 1

Returns an iterator of all the headers.

Returns
  • Iterator that returns Header objects in the sequence they are sent over a connection.

public void removeHeader (Header header)

Since: API Level 1

Removes a header from this message.

Parameters
header the header to remove.

public void removeHeaders (String name)

Since: API Level 1

Removes all headers with a certain name from this message.

Parameters
name The name of the headers to remove.

public void setHeader (Header header)

Since: API Level 1

Overwrites the first header with the same name. The new header will be appended to the end of the list, if no header with the given name can be found.

Parameters
header the header to set.

public void setHeader (String name, String value)

Since: API Level 1

Overwrites the first header with the same name. The new header will be appended to the end of the list, if no header with the given name can be found.

Parameters
name the name of the header.
value the value of the header.

public void setHeaders (Header[] headers)

Since: API Level 1

Overwrites all the headers in the message.

Parameters
headers the array of headers to set.

public void setParams (HttpParams params)

Since: API Level 1

Provides parameters to be used for the processing of this message.

Parameters
params the parameters