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

public Class BasicHeaderElement

extends Object
implements HeaderElement, Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable, org.apache.http.HeaderElement
Imports
org.apache.http.HeaderElement, .NameValuePair, org.apache.http.util.Args, .LangUtils

Basic implementation of HeaderElement
Since
4.0

Field Summary

Modifier and TypeField and Description
private final String
private final NameValuePair[]
private final String

Constructor Summary

AccessConstructor and Description
public
BasicHeaderElement(final String
header element name
name
,
final String
header element value. May be null
value
,
final NameValuePair[]
header element parameters. May be null. Parameters are copied by reference, not by value
parameters
)

Constructor with name, value and parameters.

public
BasicHeaderElement(final String
header element name
name
,
final String
header element value. May be null
value
)

Constructor 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 boolean
equals(final Object
the reference object with which to compare.
object
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public String
getName()

Implements org.apache.http.HeaderElement.getName.

Returns header element name.
public NameValuePair
getParameter(final int
index
index
)

Implements org.apache.http.HeaderElement.getParameter.

Returns parameter with the given index.
public NameValuePair
getParameterByName(final String
parameter name
name
)

Implements org.apache.http.HeaderElement.getParameterByName.

Returns the first parameter with the given name.
public int
getParameterCount()

Implements org.apache.http.HeaderElement.getParameterCount.

Returns the total count of parameters.
public NameValuePair[]
getParameters()

Implements org.apache.http.HeaderElement.getParameters.

Returns an array of name / value pairs.
public String
getValue()

Implements org.apache.http.HeaderElement.getValue.

Returns header element value.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public String
toString()

Overrides java.lang.Object.toString.

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

Field Detail

nameback to summary
private final String name
parametersback to summary
private final NameValuePair[] parameters
valueback to summary
private final String value

Constructor Detail

BasicHeaderElementback to summary
public BasicHeaderElement(final String name, final String value, final NameValuePair[] parameters)

Constructor with name, value and parameters.

Parameters
name:String

header element name

value:String

header element value. May be null

parameters:NameValuePair[]

header element parameters. May be null. Parameters are copied by reference, not by value

BasicHeaderElementback to summary
public BasicHeaderElement(final String name, final String value)

Constructor with name and value.

Parameters
name:String

header element name

value:String

header element value. May be null

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.
equalsback to summary
public boolean equals(final Object object)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
object:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getNameback to summary
public String getName()

Implements org.apache.http.HeaderElement.getName.

Doc from org.apache.http.HeaderElement.getName.

Returns header element name.

Returns:String

header element name

Annotations
@Override
getParameterback to summary
public NameValuePair getParameter(final int index)

Implements org.apache.http.HeaderElement.getParameter.

Doc from org.apache.http.HeaderElement.getParameter.

Returns parameter with the given index.

Parameters
index:int

index

Returns:NameValuePair

name / value pair

Annotations
@Override
getParameterByNameback to summary
public NameValuePair getParameterByName(final String name)

Implements org.apache.http.HeaderElement.getParameterByName.

Doc from org.apache.http.HeaderElement.getParameterByName.

Returns the first parameter with the given name.

Parameters
name:String

parameter name

Returns:NameValuePair

name / value pair

Annotations
@Override
getParameterCountback to summary
public int getParameterCount()

Implements org.apache.http.HeaderElement.getParameterCount.

Doc from org.apache.http.HeaderElement.getParameterCount.

Returns the total count of parameters.

Returns:int

parameter count

Annotations
@Override
getParametersback to summary
public NameValuePair[] getParameters()

Implements org.apache.http.HeaderElement.getParameters.

Doc from org.apache.http.HeaderElement.getParameters.

Returns an array of name / value pairs.

Returns:NameValuePair[]

array of name / value pairs

Annotations
@Override
getValueback to summary
public String getValue()

Implements org.apache.http.HeaderElement.getValue.

Doc from org.apache.http.HeaderElement.getValue.

Returns header element value.

Returns:String

header element value

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

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