io.micronaut.configuration.kafka

Class KafkaHeaders

java.lang.Object

io.micronaut.configuration.kafka.KafkaHeaders

All Implemented Interfaces:

ConvertibleMultiValues<String>, ConvertibleValues<List<String>>, Headers, MutableHeaders, ValueResolver<CharSequence>, MessageHeaders, Iterable<Map.Entry<String,List<String>>>

public class KafkaHeaders
extends Object
implements MessageHeaders

A MessageHeaders implementation for Kafka.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields inherited from interface io.micronaut.core.convert.value.ConvertibleValues

EMPTY

Constructor Summary

Constructors

Constructor and Description
KafkaHeaders(Headers headers) Constructs a new instance for the given headers.

Method Summary

Modifier and Type	Method and Description
KafkaHeaders	add(CharSequence header, CharSequence value) Add a header for the given name and value.
String	get(CharSequence name) Get a value without applying any conversion.
<T> Optional<T>	get(CharSequence name, ArgumentConversionContext<T> conversionContext) Resolve the given property for the given name.
List<String>	getAll(CharSequence name) Get all the values for the given name without applying conversion.
Set<String>	names()
KafkaHeaders	remove(CharSequence header) Removes a header.
Collection<List<String>>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.core.convert.value.ConvertibleMultiValues

empty, forEachValue, getFirst, getFirst, getFirst, getFirst, isEmpty, iterator, of

Methods inherited from interface io.micronaut.core.convert.value.ConvertibleValues

asMap, asMap, asProperties, contains, forEach, getValueType, of, subMap, subMap, subMap

Methods inherited from interface io.micronaut.core.value.ValueResolver

get, get, get

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

KafkaHeaders

public KafkaHeaders(Headers headers)

Constructs a new instance for the given headers.

Parameters:

headers - The kafka headers

Method Detail

getAll

public List<String> getAll(CharSequence name)

Description copied from interface: ConvertibleMultiValues

Get all the values for the given name without applying conversion.

Specified by:

getAll in interface ConvertibleMultiValues<String>

Parameters:

name - The header name

Returns:

All the values

get

public String get(CharSequence name)

Description copied from interface: ConvertibleMultiValues

Get a value without applying any conversion.

Specified by:

get in interface ConvertibleMultiValues<String>

Parameters:

name - The name of the value

Returns:

The raw value or null

See Also:

ConvertibleMultiValues.getFirst(CharSequence)

names

public Set<String> names()

Specified by:

names in interface ConvertibleValues<List<String>>

Returns:

The names of the values

values

public Collection<List<String>> values()

Specified by:

values in interface ConvertibleValues<List<String>>

Returns:

The values

get

public <T> Optional<T> get(CharSequence name,
                           ArgumentConversionContext<T> conversionContext)

Description copied from interface: ValueResolver

Resolve the given property for the given name.

Specified by:

get in interface ValueResolver<CharSequence>

Type Parameters:

T - The concrete type

Parameters:

name - The name

conversionContext - The conversion context

Returns:

An optional containing the property value if it exists and is able to be converted

add

public KafkaHeaders add(CharSequence header,
                        CharSequence value)

Description copied from interface: MutableHeaders

Add a header for the given name and value.

Specified by:

add in interface MutableHeaders

Parameters:

header - The head name

value - The value

Returns:

This headers object

remove

public KafkaHeaders remove(CharSequence header)

Description copied from interface: MutableHeaders

Removes a header.

Specified by:

remove in interface MutableHeaders

Parameters:

header - The header to remove

Returns:

These headers