Package org.apache.kafka.common.header

Interface Headers

All Superinterfaces:

java.lang.Iterable<Header>

public interface Headers
extends java.lang.Iterable<Header>

Method Summary

Modifier and Type	Method	Description
Headers	add(java.lang.String key, byte[] value)	Creates and adds a header, to the end, returning if the operation succeeded.
Headers	add(Header header)	Adds a header (key inside), to the end, returning if the operation succeeded.
java.lang.Iterable<Header>	headers(java.lang.String key)	Returns all headers for the given key, in the order they were added in, if present.
Header	lastHeader(java.lang.String key)	Returns just one (the very last) header for the given key, if present.
Headers	remove(java.lang.String key)	Removes all headers for the given key returning if the operation succeeded.
Header[]	toArray()	Returns all headers as an array, in the order they were added in.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

add

Headers add(Header header)
     throws java.lang.IllegalStateException

Adds a header (key inside), to the end, returning if the operation succeeded.

Parameters:

header - the Header to be added

Returns:

this instance of the Headers, once the header is added.

Throws:

java.lang.IllegalStateException - is thrown if headers are in a read-only state.

add

Headers add(java.lang.String key,
            byte[] value)
     throws java.lang.IllegalStateException

Creates and adds a header, to the end, returning if the operation succeeded.

Parameters:

key - of the header to be added.

value - of the header to be added.

Returns:

this instance of the Headers, once the header is added.

Throws:

java.lang.IllegalStateException - is thrown if headers are in a read-only state.

remove

Headers remove(java.lang.String key)
        throws java.lang.IllegalStateException

Removes all headers for the given key returning if the operation succeeded.

Parameters:

key - to remove all headers for.

Returns:

this instance of the Headers, once the header is removed.

Throws:

java.lang.IllegalStateException - is thrown if headers are in a read-only state.

lastHeader

Header lastHeader(java.lang.String key)

Returns just one (the very last) header for the given key, if present.

Parameters:

key - to get the last header for.

Returns:

this last header matching the given key, returns none if not present.

headers

java.lang.Iterable<Header> headers(java.lang.String key)

Returns all headers for the given key, in the order they were added in, if present.

Parameters:

key - to return the headers for.

Returns:

all headers for the given key, in the order they were added in, if NO headers are present an empty iterable is returned.

toArray

Header[] toArray()

Returns all headers as an array, in the order they were added in.

Returns:

the headers as a Header[], mutating this array will not affect the Headers, if NO headers are present an empty array is returned.