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

public Class BufferedHeader

extends Object
implements FormattedHeader, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, org.apache.hc.core5.http.FormattedHeader, org.apache.hc.core5.http.Header, org.apache.hc.core5.http.NameValuePair
Imports
java.io.Serializable, org.apache.hc.core5.http.FormattedHeader, .ParseException, org.apache.hc.core5.util.Args, .CharArrayBuffer, .Tokenizer
This class represents a raw HTTP header whose content is parsed 'on demand' only when the header value needs to be consumed.
Since
4.0

Field Summary

Modifier and TypeField and Description
private final CharArrayBuffer
buffer

The buffer containing the entire header line.

private final String
name

Header name.

private static final long
serialVersionUID

private final int
valuePos

The beginning of the header value in the buffer

Constructor Summary

AccessConstructor and Description
public
BufferedHeader(final CharArrayBuffer
the buffer containing the header to represent
buffer)

Creates a new header from a buffer.

pack-priv
BufferedHeader(final CharArrayBuffer buffer, final boolean strict)

Method Summary

Modifier and TypeMethod and Description
public static BufferedHeader
create(final CharArrayBuffer buffer)

public CharArrayBuffer
getBuffer()

Implements org.apache.hc.core5.http.FormattedHeader.getBuffer.

Obtains the buffer with the formatted header.
public String
getName()

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

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

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

Gets the value of this pair.
public int
getValuePos()

Implements org.apache.hc.core5.http.FormattedHeader.getValuePos.

Obtains the start of the header value in the buffer.
public boolean
isSensitive()

Implements org.apache.hc.core5.http.Header.isSensitive.

Returns true if the header should be considered sensitive.
public String
toString()

Overrides java.lang.Object.toString.

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

Field Detail

bufferback to summary
private final CharArrayBuffer buffer

The buffer containing the entire header line.

nameback to summary
private final String name

Header name.

serialVersionUIDback to summary
private static final long serialVersionUID
valuePosback to summary
private final int valuePos

The beginning of the header value in the buffer

Constructor Detail

BufferedHeaderback to summary
public BufferedHeader(final CharArrayBuffer buffer) throws ParseException

Creates a new header from a buffer. The name of the header will be parsed immediately, the value only if it is accessed.

Parameters
buffer:CharArrayBuffer

the buffer containing the header to represent

Exceptions
ParseException:
in case of a parse error
BufferedHeaderback to summary
pack-priv BufferedHeader(final CharArrayBuffer buffer, final boolean strict) throws ParseException

Method Detail

createback to summary
public static BufferedHeader create(final CharArrayBuffer buffer)
Since
5.0
getBufferback to summary
public CharArrayBuffer getBuffer()

Implements org.apache.hc.core5.http.FormattedHeader.getBuffer.

Doc from org.apache.hc.core5.http.FormattedHeader.getBuffer.

Obtains the buffer with the formatted header. The returned buffer MUST NOT be modified.

Returns:CharArrayBuffer

the formatted header, in a buffer that must not be modified

Annotations
@Override
getNameback to summary
public String getName()

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

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

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

Gets the value of this pair.

Returns:String

the value of this pair, may be null.

Annotations
@Override
getValuePosback to summary
public int getValuePos()

Implements org.apache.hc.core5.http.FormattedHeader.getValuePos.

Doc from org.apache.hc.core5.http.FormattedHeader.getValuePos.

Obtains the start of the header value in the buffer. By accessing the value in the buffer, creation of a temporary string can be avoided.

Returns:int

index of the first character of the header value in the buffer returned by getBuffer.

Annotations
@Override
isSensitiveback to summary
public boolean isSensitive()

Implements org.apache.hc.core5.http.Header.isSensitive.

Doc from org.apache.hc.core5.http.Header.isSensitive.

Returns true if the header should be considered sensitive.

Some encoding schemes such as HPACK impose restrictions on encoded representation of sensitive headers.

Returns:boolean

true if the header should be considered sensitive.

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