Class ParameterizedHeaderValue

java.lang.Object

com.soklet.ParameterizedHeaderValue

@ThreadSafe
public final class ParameterizedHeaderValue
extends Object

Represents a single HTTP header field value that includes a name and may include semicolon-delimited parameters - encoding rules per RFC specifications are strictly enforced.

Many HTTP header field values are of the form:

name *( OWS ";" OWS parameter )

where each parameter is a name=value pair.

This class provides a small builder that makes it easy to construct parameterized header values using the formal HTTP grammar terms:

• ParameterizedHeaderValue.Builder.tokenParameter(String, String) adds a parameter whose value is a token (RFC 9110).
• ParameterizedHeaderValue.Builder.quotedParameter(String, String) adds a parameter whose value is a quoted-string (RFC 9110).
• ParameterizedHeaderValue.Builder.rfc8187Parameter(String, String) adds an extended parameter (name*=) whose value is an ext-value encoded per RFC 8187 (UTF-8, percent-encoded).

Example Content-Disposition header value:

String contentDisposition = ParameterizedHeaderValue.withName("attachment")
    .quotedParameter("filename", "resume.pdf")
    .rfc8187Parameter("filename", "résumé.pdf")
    .stringValue();

// contentDisposition =>
// attachment; filename="resume.pdf"; filename*=UTF-8''r%C3%A9sum%C3%A9.pdf

The name must be ISO-8859-1 and must not contain the ';' parameter delimiter.

This class is immutable and thread-safe. The ParameterizedHeaderValue.Builder is not thread-safe.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ParameterizedHeaderValue.Builder	Builder used to construct instances of ParameterizedHeaderValue via withName(String).
static final class	ParameterizedHeaderValue.Parameter	A single header-value parameter: given a header value like attachment; filename="resume.pdf"; filename*=UTF-8''r%C3%A9sum%C3%A9.pdf, there are two filename parameter name-value pairs.
static enum	ParameterizedHeaderValue.ParameterType	What type of header-value parameter this is: ParameterizedHeaderValue.ParameterType.TOKEN, ParameterizedHeaderValue.ParameterType.QUOTED, or ParameterizedHeaderValue.ParameterType.RFC_8187.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
@NonNull String	getName()	Returns the name (non-parameter) portion of this header value.
@NonNull List<@NonNull ParameterizedHeaderValue.Parameter>	getParameters()	Returns the parameters (including their types and unencoded values) that make up this header value.
@NonNull String	getStringValue()	Returns the HTTP wire format string for this header field value: the name followed by any semicolon-delimited parameters.
int	hashCode()
@NonNull String	toString()	Returns a debug representation of this instance and its internal state.
static @NonNull ParameterizedHeaderValue.Builder	withName(@NonNull String value)

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

withName

public static @NonNull ParameterizedHeaderValue.Builder withName(@NonNull String value)

getName

public @NonNull String getName()

Returns the name (non-parameter) portion of this header value.

getStringValue

public @NonNull String getStringValue()

Returns the HTTP wire format string for this header field value: the name followed by any semicolon-delimited parameters.

This is the official string form of ParameterizedHeaderValue. No guarantees are made about toString().

Returns:

the wire-format header field value

getParameters

public @NonNull List<@NonNull ParameterizedHeaderValue.Parameter> getParameters()

Returns the parameters (including their types and unencoded values) that make up this header value.

The returned list is immutable.

toString

public @NonNull String toString()

Returns a debug representation of this instance and its internal state.

No wire-format or stability guarantees are made about this output; use getStringValue() for the wire-format header field value.

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object