Top Description Fields Constructors Methods
org.apache.http.message

public Class BasicHeader

extends Object
implements Header, Cloneable, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, java.lang.Cloneable, org.apache.http.Header, org.apache.http.NameValuePair
Annotations
@Contract
threading:IMMUTABLE
Imports
java.io.Serializable, org.apache.http.Header, .HeaderElement, .ParseException, org.apache.http.annotation.Contract, .ThreadingBehavior, org.apache.http.util.Args

Implements a basic Header.
Since
4.0

Field Summary

Modifier and TypeField and Description
private static final HeaderElement[]
private final String
private static final long
private final String

Constructor Summary

AccessConstructor and Description
public
BasicHeader(final String
the header name
name
,
final String
the header value
value
)

Constructs with name and value.

Method Summary

Modifier and TypeMethod and Description
public Object
clone()

Overrides java.lang.Object.clone.

Creates and returns a copy of this object.
public HeaderElement[]
getElements()

Implements org.apache.http.Header.getElements.

Parses the value.
public String
getName()

Implements org.apache.http.NameValuePair.getName.

Gets the name of this pair.
public String
getValue()

Implements org.apache.http.NameValuePair.getValue.

Gets the value of this pair.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
equalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

EMPTY_HEADER_ELEMENTSback to summary
private static final HeaderElement[] EMPTY_HEADER_ELEMENTS
nameback to summary
private final String name
serialVersionUIDback to summary
private static final long serialVersionUID
valueback to summary
private final String value

Constructor Detail

BasicHeaderback to summary
public BasicHeader(final String name, final String value)

Constructs with name and value.

Parameters
name:String

the header name

value:String

the header value

Method Detail

cloneback to summary
public Object clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x
will be true, and that the expression:
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that:
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object

a clone of this instance.

Annotations
@Override
Exceptions
CloneNotSupportedException:
if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.
getElementsback to summary
public HeaderElement[] getElements() throws ParseException

Implements org.apache.http.Header.getElements.

Doc from org.apache.http.Header.getElements.

Parses the value.

Returns:HeaderElement[]

an array of HeaderElement entries, may be empty, but is never null

Annotations
@Override
Exceptions
ParseException:
in case of a parsing error
getNameback to summary
public String getName()

Implements org.apache.http.NameValuePair.getName.

Doc from org.apache.http.NameValuePair.getName.

Gets the name of this pair.

Returns:String

the name of this pair, never null.

Annotations
@Override
getValueback to summary
public String getValue()

Implements org.apache.http.NameValuePair.getValue.

Doc from org.apache.http.NameValuePair.getValue.

Gets the value of this pair.

Returns:String

the value of this pair, may be null.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override