Package org.jdrupes.httpcodec.types

Class Converters

java.lang.Object

org.jdrupes.httpcodec.types.Converters

public final class Converters
extends Object

Utility methods and singletons for converters.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Converters.SameSiteAttribute	Used to control the generation of “Set-Cookie” header fields.

Field Summary

Fields

Modifier and Type	Field	Description
static final MultiValueConverter<CacheControlDirectives,Directive>	CACHE_CONTROL_LIST	A converter for cache control directives.
static final Converter<List<ParameterizedValue<String>>>	CHALLENGE_LIST	A converter for a list of challenges.
static final MultiValueConverter<CookieList,HttpCookie>	COOKIE_LIST	A converter for a list of cookies.
static final Converter<ParameterizedValue<String>>	CREDENTIALS
static final Converter<Instant>	DATE_TIME	A date/time converter.
static final Directive.DirectiveConverter	DIRECTIVE	A converter for a directive.
static final MultiValueConverter<List<Directive>,Directive>	DIRECTIVE_LIST	A converter for a list of directives.
static final Etag.EtagConverter	ETAG	A converter for an ETag header.
static final Converter<List<Etag>>	ETAG_LIST
static final Converter<Locale>	LANGUAGE	A converter for a language or language range.
static final MultiValueConverter<List<ParameterizedValue<Locale>>,ParameterizedValue<Locale>>	LANGUAGE_LIST	A converter for a weighted list of languages.
static final Converter<Long>	LONG	An integer converter.
static final MultiValueConverter<List<Long>,Long>	LONG_LIST	An integer list converter.
static final Converter<MediaRange>	MEDIA_RANGE	A converter for a media type pair with parameters.
static final MultiValueConverter<List<MediaRange>,MediaRange>	MEDIA_RANGE_LIST	A converter for a list of media ranges.
static final Converter<MediaType>	MEDIA_TYPE	A converter for a media type pair with parameters.
static final Converter<MediaBase.MediaTypePair>	MEDIA_TYPE_PAIR	A converter for the media “topLevelType/Subtype” pair.
static final org.jdrupes.httpcodec.types.Converters.ProductDescriptionConverter	PRODUCT_DESCRIPTIONS	A converter for product descriptions as used in the User-Agent and Server header fields.
static final Converter<String>	QUOTED_STRING	A converter that quotes strings.
static final Converter<StringList>	QUOTED_STRING_LIST
static final Converter<CookieList>	SET_COOKIE	A converter for set cookies.
static final Map<Converters.SameSiteAttribute,SetCookieStringConverter>	SET_COOKIE_STRING	Provide converters for the
static final Converter<String>	STRING	A converter that quotes and unquoted strings as necessary.
static final Converter<StringList>	STRING_LIST
static final Converter<String>	UNQUOTE_ONLY	A noop converter, except that text is trimmed and unquoted when converted to a value.
static final Converter<String>	UNQUOTED_STRING	A noop converter, except that text is trimmed when converted to a value.
static final Converter<URI>	URI_CONV	A converter for a URI.
static final MultiValueConverter<List<ParameterizedValue<String>>,ParameterizedValue<String>>	WEIGHTED_STRINGS	A converter for a weighted list of strings.
static final String	WILDCARD	Used by the Etag.EtagConverter to unambiguously denote a decoded wildcard.

Method Summary

Modifier and Type	Method	Description
static int	commentLength(String text, int startPos)	Determines the length of a comment in a header field.
static String	quote(String value, String toBeQuoted)	Return a new string in which all characters from toBeQuoted are prefixed with a backslash.
static String	quoteIfNecessary(String value)	Returns the given string as double quoted string if necessary.
static String	quoteString(String value)	Returns the given string as double quoted string.
static int	token68Length(String text, int startPos)	Determines the length of a token68 in a header field
static int	tokenLength(String text, int startPos)	Determines the length of a token in a header field
int	unmatchedLength(String text, int startPos, String matches)	Returns the length up to one of the match chars or end of string.
static String	unquote(String value)	If the string contains a char with a backslash before it, remove the backslash.
static String	unquoteString(String value)	If the value is double quoted, remove the quotes and escape characters.
static int	whiteSpaceLength(String text, int startPos)	Determines the length of a white space sequence in a header field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

UNQUOTED_STRING

public static final Converter<String> UNQUOTED_STRING

A noop converter, except that text is trimmed when converted to a value.

UNQUOTE_ONLY

public static final Converter<String> UNQUOTE_ONLY

A noop converter, except that text is trimmed and unquoted when converted to a value.

STRING

public static final Converter<String> STRING

A converter that quotes and unquoted strings as necessary.

STRING_LIST

public static final Converter<StringList> STRING_LIST

QUOTED_STRING

public static final Converter<String> QUOTED_STRING

A converter that quotes strings.

QUOTED_STRING_LIST

public static final Converter<StringList> QUOTED_STRING_LIST

LONG

public static final Converter<Long> LONG

An integer converter.

LONG_LIST

public static final MultiValueConverter<List<Long>,Long> LONG_LIST

An integer list converter.

DATE_TIME

public static final Converter<Instant> DATE_TIME

A date/time converter.

SET_COOKIE_STRING

public static final Map<Converters.SameSiteAttribute,SetCookieStringConverter> SET_COOKIE_STRING

Provide converters for the

SET_COOKIE

public static final Converter<CookieList> SET_COOKIE

A converter for set cookies.

COOKIE_LIST

public static final MultiValueConverter<CookieList,HttpCookie> COOKIE_LIST

A converter for a list of cookies.

Supports the format used in the “Cookie” header.

See Also:

• Cookie

LANGUAGE

public static final Converter<Locale> LANGUAGE

A converter for a language or language range.

Language range “*” is converted to a Locale with an empty language.

LANGUAGE_LIST

public static final MultiValueConverter<List<ParameterizedValue<Locale>>,ParameterizedValue<Locale>> LANGUAGE_LIST

A converter for a weighted list of languages.

WEIGHTED_STRINGS

public static final MultiValueConverter<List<ParameterizedValue<String>>,ParameterizedValue<String>> WEIGHTED_STRINGS

A converter for a weighted list of strings.

MEDIA_TYPE_PAIR

public static final Converter<MediaBase.MediaTypePair> MEDIA_TYPE_PAIR

A converter for the media “topLevelType/Subtype” pair.

MEDIA_RANGE

public static final Converter<MediaRange> MEDIA_RANGE

A converter for a media type pair with parameters.

MEDIA_RANGE_LIST

public static final MultiValueConverter<List<MediaRange>,MediaRange> MEDIA_RANGE_LIST

A converter for a list of media ranges.

MEDIA_TYPE

public static final Converter<MediaType> MEDIA_TYPE

A converter for a media type pair with parameters.

DIRECTIVE

public static final Directive.DirectiveConverter DIRECTIVE

A converter for a directive.

DIRECTIVE_LIST

public static final MultiValueConverter<List<Directive>,Directive> DIRECTIVE_LIST

A converter for a list of directives.

CACHE_CONTROL_LIST

public static final MultiValueConverter<CacheControlDirectives,Directive> CACHE_CONTROL_LIST

A converter for cache control directives.

URI_CONV

public static final Converter<URI> URI_CONV

A converter for a URI.

PRODUCT_DESCRIPTIONS

public static final org.jdrupes.httpcodec.types.Converters.ProductDescriptionConverter PRODUCT_DESCRIPTIONS

A converter for product descriptions as used in the User-Agent and Server header fields.

WILDCARD

public static final String WILDCARD

Used by the Etag.EtagConverter to unambiguously denote a decoded wildcard.

If the result of fromFieldValue == WILDCARD, the field value was an unquoted asterisk. If the result equals("*"), it may also have been a quoted asterisk.

See Also:

• Constant Field Values

ETAG

public static final Etag.EtagConverter ETAG

A converter for an ETag header.

ETAG_LIST

public static final Converter<List<Etag>> ETAG_LIST

CHALLENGE_LIST

public static final Converter<List<ParameterizedValue<String>>> CHALLENGE_LIST

A converter for a list of challenges.

CREDENTIALS

public static final Converter<ParameterizedValue<String>> CREDENTIALS

Method Details

unquote

public static String unquote(String value)

If the string contains a char with a backslash before it, remove the backslash.

Parameters:

value - the value to unquote

Returns:

the unquoted value

Throws:

ParseException - if the input violates the field format

See Also:

• Field value components

unquoteString

public static String unquoteString(String value)
                            throws ParseException

If the value is double quoted, remove the quotes and escape characters.

Parameters:

value - the value to unquote

Returns:

the unquoted value

Throws:

ParseException - if the input violates the field format

See Also:

• Field value components

quoteIfNecessary

public static String quoteIfNecessary(String value)

Returns the given string as double quoted string if necessary.

Parameters:

value - the value to quote if necessary

Returns:

the result

See Also:

• Field value components

quoteString

public static String quoteString(String value)

Returns the given string as double quoted string.

Parameters:

value - the value to quote

Returns:

the result

quote

public static String quote(String value,
 String toBeQuoted)

Return a new string in which all characters from toBeQuoted are prefixed with a backslash.

Parameters:

value - the string

toBeQuoted - the characters to be quoted

Returns:

the result

See Also:

• Field value components

tokenLength

public static int tokenLength(String text,
 int startPos)

Determines the length of a token in a header field

Parameters:

text - the text to parse

startPos - the start position

Returns:

the length of the token

See Also:

• RFC 7230, Section 3.2.6

token68Length

public static int token68Length(String text,
 int startPos)

Determines the length of a token68 in a header field

Parameters:

text - the text to parse

startPos - the start position

Returns:

the length of the token

See Also:

• RFC 7235, Section 2.1

whiteSpaceLength

public static int whiteSpaceLength(String text,
 int startPos)

Determines the length of a white space sequence in a header field.

Parameters:

text - the test to parse

startPos - the start position

Returns:

the length of the white space sequence

See Also:

• RFC 7230, Section 3.2.3

commentLength

public static int commentLength(String text,
 int startPos)

Determines the length of a comment in a header field.

Parameters:

text - the text to parse

startPos - the starting position (must be the position of the opening brace)

Returns:

the length of the comment

See Also:

• RFC 7230, Section 3.2.6

unmatchedLength

public int unmatchedLength(String text,
 int startPos,
 String matches)

Returns the length up to one of the match chars or end of string.

Parameters:

text - the text

startPos - the start position

matches - the chars to match

Returns:

the length