org.apache.kafka.connect.header

Interface Headers

All Superinterfaces:

java.lang.Iterable<Header>

All Known Implementing Classes:

ConnectHeaders

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

A mutable ordered collection of Header objects. Note that multiple headers may have the same key.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Headers.HeaderTransform A function to transform the supplied Header.

Method Summary

Modifier and Type	Method and Description
Headers	add(Header header) Add the given Header to this collection.
Headers	add(java.lang.String key, java.lang.Object value, Schema schema) Add to this collection a Header with the given key and value.
Headers	add(java.lang.String key, SchemaAndValue schemaAndValue) Add to this collection a Header with the given key and value.
Headers	addBoolean(java.lang.String key, boolean value) Add to this collection a Header with the given key and value.
Headers	addByte(java.lang.String key, byte value) Add to this collection a Header with the given key and value.
Headers	addBytes(java.lang.String key, byte[] value) Add to this collection a Header with the given key and value.
Headers	addDate(java.lang.String key, java.util.Date value) Add to this collection a Header with the given key and Date value.
Headers	addDecimal(java.lang.String key, java.math.BigDecimal value) Add to this collection a Header with the given key and Decimal value.
Headers	addDouble(java.lang.String key, double value) Add to this collection a Header with the given key and value.
Headers	addFloat(java.lang.String key, float value) Add to this collection a Header with the given key and value.
Headers	addInt(java.lang.String key, int value) Add to this collection a Header with the given key and value.
Headers	addList(java.lang.String key, java.util.List<?> value, Schema schema) Add to this collection a Header with the given key and value.
Headers	addLong(java.lang.String key, long value) Add to this collection a Header with the given key and value.
Headers	addMap(java.lang.String key, java.util.Map<?,?> value, Schema schema) Add to this collection a Header with the given key and value.
Headers	addShort(java.lang.String key, short value) Add to this collection a Header with the given key and value.
Headers	addString(java.lang.String key, java.lang.String value) Add to this collection a Header with the given key and value.
Headers	addStruct(java.lang.String key, Struct value) Add to this collection a Header with the given key and value.
Headers	addTime(java.lang.String key, java.util.Date value) Add to this collection a Header with the given key and Time value.
Headers	addTimestamp(java.lang.String key, java.util.Date value) Add to this collection a Header with the given key and Timestamp value.
java.util.Iterator<Header>	allWithName(java.lang.String key) Get the collection of Header objects whose keys all match the specified key.
Headers	apply(Headers.HeaderTransform transform) Get all Headers, apply the transform to each and store the result in place of the original.
Headers	apply(java.lang.String key, Headers.HeaderTransform transform) Get all Headers with the given key, apply the transform to each and store the result in place of the original.
Headers	clear() Removes all headers from this object.
Headers	duplicate() Create a copy of this Headers object.
boolean	isEmpty() Determine whether this object has no headers.
Header	lastWithName(java.lang.String key) Return the last Header with the specified key.
Headers	remove(java.lang.String key) Removes all Header objects whose key matches the specified key.
Headers	retainLatest() Removes all but the last object with each key.
Headers	retainLatest(java.lang.String key) Removes all but the latest Header objects whose key matches the specified key.
int	size() Get the number of headers in this object.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

size

int size()

Get the number of headers in this object.

Returns:

the number of headers; never negative

isEmpty

boolean isEmpty()

Determine whether this object has no headers.

Returns:

true if there are no headers, or false if there is at least one header

allWithName

java.util.Iterator<Header> allWithName(java.lang.String key)

Get the collection of Header objects whose keys all match the specified key.

Parameters:

key - the key; may not be null

Returns:

the iterator over headers with the specified key; may be null if there are no headers with the specified key

lastWithName

Header lastWithName(java.lang.String key)

Return the last Header with the specified key.

Parameters:

key - the key for the header; may not be null

Returns:

the last Header, or null if there are no headers with the specified key

add

Headers add(Header header)

Add the given Header to this collection.

Parameters:

header - the header; may not be null

Returns:

this object to facilitate chaining multiple methods; never null

add

Headers add(java.lang.String key,
            SchemaAndValue schemaAndValue)

Add to this collection a Header with the given key and value.

Parameters:

key - the header's key; may not be null

schemaAndValue - the SchemaAndValue for the header; may be null

Returns:

this object to facilitate chaining multiple methods; never null

add

Headers add(java.lang.String key,
            java.lang.Object value,
            Schema schema)

Add to this collection a Header with the given key and value.

Parameters:

key - the header's key; may not be null

value - the header's value; may be null

schema - the schema for the header's value; may not be null if the value is not null

Returns:

this object to facilitate chaining multiple methods; never null

addString

Headers addString(java.lang.String key,
                  java.lang.String value)

Add to this collection a Header with the given key and value.

Parameters:

key - the header's key; may not be null

value - the header's value; may be null

Returns:

this object to facilitate chaining multiple methods; never null

addBoolean

Headers addBoolean(java.lang.String key,
                   boolean value)

Add to this collection a Header with the given key and value.

Parameters:

key - the header's key; may not be null

value - the header's value; may be null

Returns:

this object to facilitate chaining multiple methods; never null

addByte

Headers addByte(java.lang.String key,
                byte value)

Add to this collection a Header with the given key and value.

Parameters:

key - the header's key; may not be null

value - the header's value; may be null

Returns:

this object to facilitate chaining multiple methods; never null

addShort

Headers addShort(java.lang.String key,
                 short value)

Add to this collection a Header with the given key and value.

Parameters:

key - the header's key; may not be null

value - the header's value; may be null

Returns:

this object to facilitate chaining multiple methods; never null

addInt

Headers addInt(java.lang.String key,
               int value)

Add to this collection a Header with the given key and value.

Parameters:

key - the header's key; may not be null

value - the header's value; may be null

Returns:

this object to facilitate chaining multiple methods; never null

addLong

Headers addLong(java.lang.String key,
                long value)

Add to this collection a Header with the given key and value.

Parameters:

key - the header's key; may not be null

value - the header's value; may be null

Returns:

this object to facilitate chaining multiple methods; never null

addFloat

Headers addFloat(java.lang.String key,
                 float value)

Add to this collection a Header with the given key and value.

Parameters:

key - the header's key; may not be null

value - the header's value; may be null

Returns:

this object to facilitate chaining multiple methods; never null

addDouble

Headers addDouble(java.lang.String key,
                  double value)

Add to this collection a Header with the given key and value.

Parameters:

key - the header's key; may not be null

value - the header's value; may be null

Returns:

this object to facilitate chaining multiple methods; never null

addBytes

Headers addBytes(java.lang.String key,
                 byte[] value)

Add to this collection a Header with the given key and value.

Parameters:

key - the header's key; may not be null

value - the header's value; may be null

Returns:

this object to facilitate chaining multiple methods; never null

addList

Headers addList(java.lang.String key,
                java.util.List<?> value,
                Schema schema)

Add to this collection a Header with the given key and value.

Parameters:

key - the header's key; may not be null

value - the header's value; may be null

schema - the schema describing the list value; may not be null

Returns:

this object to facilitate chaining multiple methods; never null

Throws:

DataException - if the header's value is invalid

addMap

Headers addMap(java.lang.String key,
               java.util.Map<?,?> value,
               Schema schema)

Add to this collection a Header with the given key and value.

Parameters:

key - the header's key; may not be null

value - the header's value; may be null

schema - the schema describing the map value; may not be null

Returns:

this object to facilitate chaining multiple methods; never null

Throws:

DataException - if the header's value is invalid

addStruct

Headers addStruct(java.lang.String key,
                  Struct value)

Add to this collection a Header with the given key and value.

Parameters:

key - the header's key; may not be null

value - the header's value; may be null

Returns:

this object to facilitate chaining multiple methods; never null

Throws:

DataException - if the header's value is invalid

addDecimal

Headers addDecimal(java.lang.String key,
                   java.math.BigDecimal value)

Add to this collection a Header with the given key and Decimal value.

Parameters:

key - the header's key; may not be null

value - the header's Decimal value; may be null

Returns:

this object to facilitate chaining multiple methods; never null

addDate

Headers addDate(java.lang.String key,
                java.util.Date value)

Add to this collection a Header with the given key and Date value.

Parameters:

key - the header's key; may not be null

value - the header's Date value; may be null

Returns:

this object to facilitate chaining multiple methods; never null

addTime

Headers addTime(java.lang.String key,
                java.util.Date value)

Add to this collection a Header with the given key and Time value.

Parameters:

key - the header's key; may not be null

value - the header's Time value; may be null

Returns:

this object to facilitate chaining multiple methods; never null

addTimestamp

Headers addTimestamp(java.lang.String key,
                     java.util.Date value)

Add to this collection a Header with the given key and Timestamp value.

Parameters:

key - the header's key; may not be null

value - the header's Timestamp value; may be null

Returns:

this object to facilitate chaining multiple methods; never null

remove

Headers remove(java.lang.String key)

Removes all Header objects whose key matches the specified key.

Parameters:

key - the key; may not be null

Returns:

this object to facilitate chaining multiple methods; never null

retainLatest

Headers retainLatest(java.lang.String key)

Removes all but the latest Header objects whose key matches the specified key.

Parameters:

key - the key; may not be null

Returns:

this object to facilitate chaining multiple methods; never null

retainLatest

Headers retainLatest()

Removes all but the last object with each key.

Returns:

this object to facilitate chaining multiple methods; never null

clear

Headers clear()

Removes all headers from this object.

Returns:

this object to facilitate chaining multiple methods; never null

duplicate

Headers duplicate()

Create a copy of this Headers object. The new copy will contain all of the same Header objects as this object.

Returns:

the copy; never null

apply

Headers apply(Headers.HeaderTransform transform)

Get all Headers, apply the transform to each and store the result in place of the original.

Parameters:

transform - the transform to apply; may not be null

Returns:

this object to facilitate chaining multiple methods; never null

Throws:

DataException - if the header's value is invalid

apply

Headers apply(java.lang.String key,
              Headers.HeaderTransform transform)

Get all Headers with the given key, apply the transform to each and store the result in place of the original.

Parameters:

key - the header's key; may not be null

transform - the transform to apply; may not be null

Returns:

this object to facilitate chaining multiple methods; never null

Throws:

DataException - if the header's value is invalid