reactor.bus

Class Event.Headers

java.lang.Object

reactor.bus.Event.Headers

All Implemented Interfaces:

Serializable, Iterable<Tuple2<String,Object>>

Enclosing class:

Event<T>

public static class Event.Headers
extends Object
implements Serializable, Iterable<Tuple2<String,Object>>

Headers are a Map-like structure of name-value pairs. Header names are case-insensitive, as determined by String.CASE_INSENSITIVE_ORDER. A header can be removed by setting its value to null.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ORIGIN The name of the origin header

Constructor Summary

Constructors

Constructor and Description
Headers() Create an empty Headers
Headers(Map<String,Object> headers) Creates a new Headers instance by copying the contents of the given headers Map.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asMap() Get these headers as an unmodifiable Map.
boolean	contains(String name) Determine whether the headers contain a value for the given name.
<V> V	get(String name) Get the value for the given header.
String	getOrigin() Get the origin header
Iterator<Tuple2<String,Object>>	iterator() Returns an unmodifiable Iterator over a copy of this Headers' contents.
Event.Headers	readOnly() Get the headers as a read-only version
<V> Event.Headers	set(String name, V value) Set the header value.
Event.Headers	setAll(Map<String,Object> headers) Sets all of the headers represented by entries in the given headers Map.
Event.Headers	setOrigin(String id) Set the origin header.
Event.Headers	setOrigin(UUID id) Set the origin header.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

ORIGIN

public static final String ORIGIN

The name of the origin header

See Also:

setOrigin(String), setOrigin(UUID), getOrigin(), Constant Field Values

Constructor Detail

Headers

public Headers(Map<String,Object> headers)

Creates a new Headers instance by copying the contents of the given headers Map. Note that, as the map is copied, subsequent changes to its contents will have no effect upon the Headers.

Parameters:

headers - The map to copy.

Headers

public Headers()

Create an empty Headers

Method Detail

setAll

public Event.Headers setAll(Map<String,Object> headers)

Sets all of the headers represented by entries in the given headers Map. Any entry with a null value will cause the header matching the entry's name to be removed.

Parameters:

headers - The map of headers to set.

Returns:

this

set

public <V> Event.Headers set(String name,
                             V value)

Set the header value. If value is null the header with the given name will be removed.

Parameters:

name - The name of the header.

value - The header's value.

Returns:

this

setOrigin

public Event.Headers setOrigin(UUID id)

Set the origin header. The origin is simply a unique id to indicate to consumers where it should send replies. If id is null the origin header will be removed.

Parameters:

id - The id of the origin component.

Returns:

this

getOrigin

public String getOrigin()

Get the origin header

Returns:

The origin header, may be null.

setOrigin

public Event.Headers setOrigin(String id)

Set the origin header. The origin is simply a unique id to indicate to consumers where it should send replies. If id is null this origin header will be removed.

Parameters:

id - The id of the origin component.

Returns:

this

get

public <V> V get(String name)

Get the value for the given header.

Parameters:

name - The header name.

Returns:

The value of the header, or null if none exists.

contains

public boolean contains(String name)

Determine whether the headers contain a value for the given name.

Parameters:

name - The header name.

Returns:

true if a value exists, false otherwise.

asMap

public Map<String,Object> asMap()

Get these headers as an unmodifiable Map.

Returns:

The unmodifiable header map

readOnly

public Event.Headers readOnly()

Get the headers as a read-only version

Returns:

A read-only version of the headers.

iterator

public Iterator<Tuple2<String,Object>> iterator()

Returns an unmodifiable Iterator over a copy of this Headers' contents.

Specified by:

iterator in interface Iterable<Tuple2<String,Object>>

toString

public String toString()

Overrides:

toString in class Object