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

public Class BasicHeaderElement

extends Object
implements HeaderElement
Class Inheritance
All Implemented Interfaces
org.apache.hc.core5.http.HeaderElement
Imports
org.apache.hc.core5.http.HeaderElement, .NameValuePair, org.apache.hc.core5.util.Args
Basic implementation of HeaderElement
Since
4.0

Field Summary

Modifier and TypeField and Description
private static final NameValuePair[]
EMPTY_NAME_VALUE_PAIR_ARRAY

private final String
name

private final NameValuePair[]
parameters

private final String
value

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 String
getName()

Implements org.apache.hc.core5.http.HeaderElement.getName.

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

Implements org.apache.hc.core5.http.HeaderElement.getParameter.

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

Implements org.apache.hc.core5.http.HeaderElement.getParameterByName.

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

Implements org.apache.hc.core5.http.HeaderElement.getParameterCount.

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

Implements org.apache.hc.core5.http.HeaderElement.getParameters.

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

Implements org.apache.hc.core5.http.HeaderElement.getValue.

Returns header element value.
public String
toString()

Overrides java.lang.Object.toString.

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

Field Detail

EMPTY_NAME_VALUE_PAIR_ARRAYback to summary
private static final NameValuePair[] EMPTY_NAME_VALUE_PAIR_ARRAY
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

getNameback to summary
public String getName()

Implements org.apache.hc.core5.http.HeaderElement.getName.

Doc from org.apache.hc.core5.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.hc.core5.http.HeaderElement.getParameter.

Doc from org.apache.hc.core5.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.hc.core5.http.HeaderElement.getParameterByName.

Doc from org.apache.hc.core5.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.hc.core5.http.HeaderElement.getParameterCount.

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

Returns the total count of parameters.

Returns:int

parameter count

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

Implements org.apache.hc.core5.http.HeaderElement.getParameters.

Doc from org.apache.hc.core5.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.hc.core5.http.HeaderElement.getValue.

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

Returns header element value.

Returns:String

header element value

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