Used to decode string literals as described in RFC7541.

The string literal representation consists of a single bit to indicate whether huffman encoding is used, followed by the string byte length encoded with the n-bit integer representation also from RFC7541, and the bytes of the string are directly after this.

Characters which are illegal field-vchar values are replaced with either ' ' or '?' as described in RFC9110

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static enum	NBitStringDecoder.State

Field Summary

Modifier and Type	Field and Description
private final CharsetStringBuilder.Iso88591StringBuilder	_builder
private int	_count
private boolean	_huffman
private final HuffmanDecoder	_huffmanBuilder
private final NBitIntegerDecoder	_integerDecoder
private int	_length
private int	_prefix
private NBitStringDecoder.State	_state

Access	Constructor and Description
public	NBitStringDecoder()

Method Summary

Modifier and Type	Method and Description
public String	Returns: the decoded string or null to indicate that more data is needed. decode(ByteBuffer the buffer containing the encoded string. buffer) Decode a string from the buffer.
public void	reset()
public void	setPrefix(int the number of bits in the string prefix. prefix) Set the prefix length in of the string representation in bits.
private String	stringDecode(ByteBuffer buffer)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_builder	back to summary
private final CharsetStringBuilder.Iso88591StringBuilder _builder

_count	back to summary
private int _count

_huffman	back to summary
private boolean _huffman

_huffmanBuilder	back to summary
private final HuffmanDecoder _huffmanBuilder

_integerDecoder	back to summary
private final NBitIntegerDecoder _integerDecoder

_length	back to summary
private int _length

_prefix	back to summary
private int _prefix

_state	back to summary
private NBitStringDecoder.State _state

NBitStringDecoder	back to summary
public NBitStringDecoder()

Method Detail

decode back to summary

decode	back to summary
public String decode(ByteBuffer buffer) throws EncodingException Decode a string from the buffer. If the buffer does not contain the complete string representation then a value of null is returned to indicate that more data is needed to complete parsing. This should be only after the prefix has been set with `setPrefix(int)`. Parameters buffer:ByteBuffer the buffer containing the encoded string. Returns:String the decoded string or null to indicate that more data is needed. Exceptions EncodingException: if the string encoding is invalid. ArithmeticException: if the string length value overflows a int.

public String decode(ByteBuffer buffer) throws EncodingException

Decode a string from the buffer. If the buffer does not contain the complete string representation then a value of null is returned to indicate that more data is needed to complete parsing. This should be only after the prefix has been set with setPrefix(int).

Parameters

buffer:ByteBuffer: the buffer containing the encoded string.

Returns:String

the decoded string or null to indicate that more data is needed.

Exceptions

EncodingException:: if the string encoding is invalid.
ArithmeticException:: if the string length value overflows a int.

reset	back to summary
public void reset()

setPrefix	back to summary
public void setPrefix(int prefix) Set the prefix length in of the string representation in bits. A prefix of 6 means the string representation starts after the first 2 bits. Parameters prefix:int the number of bits in the string prefix.

setPrefix

back to summary

public void setPrefix(int prefix)

Set the prefix length in of the string representation in bits. A prefix of 6 means the string representation starts after the first 2 bits.

Parameters

prefix:int: the number of bits in the string prefix.

stringDecode	back to summary
private String stringDecode(ByteBuffer buffer)

org.eclipse.jetty.http.compression back to summary

private final Enum NBitStringDecoder.State

Class Inheritance

extends Enum<NBitStringDecoder.State>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.http.compression.NBitStringDecoder.State

Field Summary

Modifier and Type	Field and Description
public static final NBitStringDecoder.State	LENGTH
public static final NBitStringDecoder.State	PARSING
public static final NBitStringDecoder.State	VALUE

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static NBitStringDecoder.State	valueOf(String name)
public static NBitStringDecoder.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

LENGTH	back to summary
public static final NBitStringDecoder.State LENGTH

PARSING	back to summary
public static final NBitStringDecoder.State PARSING

VALUE	back to summary
public static final NBitStringDecoder.State VALUE

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static NBitStringDecoder.State valueOf(String name)

values	back to summary
public static NBitStringDecoder.State[] values()

public Class NBitStringDecoder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum NBitStringDecoder.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail