Package org.jdrupes.httpcodec.types

Class DefaultMultiValueConverter<T extends Iterable<V>,V>

java.lang.Object

org.jdrupes.httpcodec.types.DefaultMultiValueConverter<T,V>

Type Parameters:

T - the container for the values

V - the type of the values

All Implemented Interfaces:

Converter<T>, MultiValueConverter<T,V>

public class DefaultMultiValueConverter<T extends Iterable<V>,V>
extends Object
implements MultiValueConverter<T,V>

Used by by converters that convert header fields with a list of values.

Minimal restrictions are imposed on the type used as container for the values. It must be Iterable to provide read access. A supplier and a function for appending values provide the required write access.

Constructor Summary

Constructors

Constructor	Description
DefaultMultiValueConverter(Supplier<T> containerSupplier, BiConsumer<T,V> valueAdder, Converter<V> valueConverter, String delimiters, boolean separateValues)	Create a new converter.
DefaultMultiValueConverter(Supplier<T> containerSupplier, Converter<V> itemConverter)	Create a new converter for a container that implements Collection, does not generate separate header fields and uses a comma as separator.
DefaultMultiValueConverter(Supplier<T> containerSupplier, Converter<V> valueConverter, String delimiters)	Create a new converter for a container that implements Collection and does not generate separate header fields.

Method Summary

Modifier and Type	Method	Description
String	asFieldValue(T value)	Returns the representation of this value in a header field.
Supplier<T>	containerSupplier()	Returns the container supplier
T	fromFieldValue(String text)	Parses the given text and returns the parsed value.
boolean	separateValues()	Return whether values should be converted to separate header fields in Converter.asFieldValue(Object).
BiConsumer<T,V>	valueAdder()	Returns the value adder
Converter<V>	valueConverter()	Deprecated.
Converter<V>	valueConverter(T value)	Returns the value converter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jdrupes.httpcodec.types.MultiValueConverter

asHeaderField

Constructor Details

DefaultMultiValueConverter

public DefaultMultiValueConverter(Supplier<T> containerSupplier,
 BiConsumer<T,V> valueAdder,
 Converter<V> valueConverter,
 String delimiters,
 boolean separateValues)

Create a new converter.

Parameters:

containerSupplier - a function that creates a new empty container

valueAdder - a function that adds a value to the sequence

valueConverter - the converter for the individual values

delimiters - the delimiters

separateValues - indicates that each value should be represented by a header field of its own in a message header

DefaultMultiValueConverter

public DefaultMultiValueConverter(Supplier<T> containerSupplier,
 Converter<V> valueConverter,
 String delimiters)

Create a new converter for a container that implements Collection and does not generate separate header fields.

Parameters:

containerSupplier - a function that creates a new empty list

valueConverter - the converter for the items

delimiters - the delimiters

DefaultMultiValueConverter

public DefaultMultiValueConverter(Supplier<T> containerSupplier,
 Converter<V> itemConverter)

Create a new converter for a container that implements Collection, does not generate separate header fields and uses a comma as separator.

Parameters:

containerSupplier - a function that creates a new empty list

itemConverter - the converter for the items

See Also:

• ABNF List Extension

Method Details

separateValues

public boolean separateValues()

Description copied from interface: MultiValueConverter

Return whether values should be converted to separate header fields in Converter.asFieldValue(Object).

Specified by:

separateValues in interface MultiValueConverter<T extends Iterable<V>,V>

Returns:

the value

containerSupplier

public Supplier<T> containerSupplier()

Description copied from interface: MultiValueConverter

Returns the container supplier

Specified by:

containerSupplier in interface MultiValueConverter<T extends Iterable<V>,V>

Returns:

the container supplier

valueAdder

public BiConsumer<T,V> valueAdder()

Description copied from interface: MultiValueConverter

Returns the value adder

Specified by:

valueAdder in interface MultiValueConverter<T extends Iterable<V>,V>

Returns:

the value adder

valueConverter

@Deprecated
public Converter<V> valueConverter()

Deprecated.

Description copied from interface: MultiValueConverter

Returns the value converter.

Specified by:

valueConverter in interface MultiValueConverter<T extends Iterable<V>,V>

Returns:

the value converter

valueConverter

public Converter<V> valueConverter(T value)

Description copied from interface: MultiValueConverter

Returns the value converter.

In most cases, the result will be independent of the container type or instance. However, passing it makes the selection more flexible.

Specified by:

valueConverter in interface MultiValueConverter<T extends Iterable<V>,V>

Returns:

the value converter

asFieldValue

public String asFieldValue(T value)

Description copied from interface: Converter

Returns the representation of this value in a header field.

Specified by:

asFieldValue in interface Converter<T extends Iterable<V>>

Parameters:

value - the value to be converted

Returns:

the representation

fromFieldValue

public T fromFieldValue(String text)
                 throws ParseException

Description copied from interface: Converter

Parses the given text and returns the parsed value.

Specified by:

fromFieldValue in interface Converter<T extends Iterable<V>>

Parameters:

text - the value from the header field

Returns:

the parsed value

Throws:

ParseException - if the value cannot be parsed