Package org.apache.kafka.connect.header

Class ConnectHeaders

java.lang.Object

org.apache.kafka.connect.header.ConnectHeaders

All Implemented Interfaces:

java.lang.Iterable<Header>, Headers

public class ConnectHeaders
extends java.lang.Object
implements Headers

A basic Headers implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.kafka.connect.header.Headers

Headers.HeaderTransform

Constructor Summary

Constructors

Constructor	Description
ConnectHeaders()
ConnectHeaders(java.lang.Iterable<Header> original)

Method Summary

Modifier and Type	Method	Description
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	add(Header header)	Add the given Header to this collection.
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.
protected Headers	addWithoutValidating(java.lang.String key, java.lang.Object value, Schema schema)
java.util.Iterator<Header>	allWithName(java.lang.String key)	Get the collection of Header objects whose keys all match the specified key.
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	apply(Headers.HeaderTransform transform)	Get all Headers, apply the transform to each and store the result in place of the original.
Headers	clear()	Removes all headers from this object.
ConnectHeaders	duplicate()	Create a copy of this Headers object.
boolean	equals(java.lang.Object obj)
int	hashCode()
boolean	isEmpty()	Determine whether this object has no headers.
java.util.Iterator<Header>	iterator()
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.
java.lang.String	toString()

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConnectHeaders

public ConnectHeaders()

ConnectHeaders

public ConnectHeaders(java.lang.Iterable<Header> original)

Method Detail

size

public int size()

Description copied from interface: Headers

Get the number of headers in this object.

Specified by:

size in interface Headers

Returns:

the number of headers; never negative

isEmpty

public boolean isEmpty()

Description copied from interface: Headers

Determine whether this object has no headers.

Specified by:

isEmpty in interface Headers

Returns:

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

clear

public Headers clear()

Description copied from interface: Headers

Removes all headers from this object.

Specified by:

clear in interface Headers

Returns:

this object to facilitate chaining multiple methods; never null

add

public Headers add(Header header)

Description copied from interface: Headers

Add the given Header to this collection.

Specified by:

add in interface Headers

Parameters:

header - the header; may not be null

Returns:

this object to facilitate chaining multiple methods; never null

addWithoutValidating

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

add

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

Description copied from interface: Headers

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

Specified by:

add in interface Headers

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

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

Description copied from interface: Headers

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

Specified by:

add in interface Headers

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

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

Description copied from interface: Headers

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

Specified by:

addString in interface Headers

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

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

Description copied from interface: Headers

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

Specified by:

addBytes in interface Headers

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

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

Description copied from interface: Headers

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

Specified by:

addBoolean in interface Headers

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

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

Description copied from interface: Headers

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

Specified by:

addByte in interface Headers

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

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

Description copied from interface: Headers

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

Specified by:

addShort in interface Headers

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

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

Description copied from interface: Headers

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

Specified by:

addInt in interface Headers

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

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

Description copied from interface: Headers

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

Specified by:

addLong in interface Headers

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

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

Description copied from interface: Headers

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

Specified by:

addFloat in interface Headers

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

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

Description copied from interface: Headers

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

Specified by:

addDouble in interface Headers

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

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

Description copied from interface: Headers

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

Specified by:

addList in interface Headers

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

addMap

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

Description copied from interface: Headers

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

Specified by:

addMap in interface Headers

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

addStruct

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

Description copied from interface: Headers

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

Specified by:

addStruct in interface Headers

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

addDecimal

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

Description copied from interface: Headers

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

Specified by:

addDecimal in interface Headers

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

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

Description copied from interface: Headers

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

Specified by:

addDate in interface Headers

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

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

Description copied from interface: Headers

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

Specified by:

addTime in interface Headers

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

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

Description copied from interface: Headers

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

Specified by:

addTimestamp in interface Headers

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

lastWithName

public Header lastWithName(java.lang.String key)

Description copied from interface: Headers

Return the last Header with the specified key.

Specified by:

lastWithName in interface Headers

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

allWithName

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

Description copied from interface: Headers

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

Specified by:

allWithName in interface Headers

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

iterator

public java.util.Iterator<Header> iterator()

Specified by:

iterator in interface java.lang.Iterable<Header>

remove

public Headers remove(java.lang.String key)

Description copied from interface: Headers

Removes all Header objects whose key matches the specified key.

Specified by:

remove in interface Headers

Parameters:

key - the key; may not be null

Returns:

this object to facilitate chaining multiple methods; never null

retainLatest

public Headers retainLatest()

Description copied from interface: Headers

Removes all but the last object with each key.

Specified by:

retainLatest in interface Headers

Returns:

this object to facilitate chaining multiple methods; never null

retainLatest

public Headers retainLatest(java.lang.String key)

Description copied from interface: Headers

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

Specified by:

retainLatest in interface Headers

Parameters:

key - the key; may not be null

Returns:

this object to facilitate chaining multiple methods; never null

apply

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

Description copied from interface: Headers

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

Specified by:

apply in interface Headers

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

apply

public Headers apply(Headers.HeaderTransform transform)

Description copied from interface: Headers

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

Specified by:

apply in interface Headers

Parameters:

transform - the transform to apply; may not be null

Returns:

this object to facilitate chaining multiple methods; never null

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

duplicate

public ConnectHeaders duplicate()

Description copied from interface: Headers

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

Specified by:

duplicate in interface Headers

Returns:

the copy; never null