org.springframework.integration.test.matcher
Class HeaderMatcher

java.lang.Object
  org.hamcrest.BaseMatcher<T>
      org.springframework.integration.test.matcher.HeaderMatcher

All Implemented Interfaces:

org.hamcrest.Matcher<Message<?>>, org.hamcrest.SelfDescribing

public class HeaderMatcher
extends org.hamcrest.BaseMatcher<T>

Are the MessageHeaders of a Message containing any entry or multiple that match?

For example using Assert.assertThat(Object, Matcher) for a single entry:

 ANY_HEADER_KEY = "foo";
 ANY_HEADER_VALUE = "bar";
 assertThat(message, hasEntry(ANY_HEADER_KEY, ANY_HEADER_VALUE));
 assertThat(message, hasEntry(ANY_HEADER_KEY, is(String.class)));
 assertThat(message, hasEntry(ANY_HEADER_KEY, notNullValue()));
 assertThat(message, hasEntry(ANY_HEADER_KEY, is(ANY_HEADER_VALUE)));
 

For multiple entries to match all:

 Map<String, Object> expectedInHeaderMap = new HashMap<String, Object>();
 expectedInHeaderMap.put(ANY_HEADER_KEY, ANY_HEADER_VALUE);
 expectedInHeaderMap.put(OTHER_HEADER_KEY, is(OTHER_HEADER_VALUE));
 assertThat(message, HeaderMatcher.hasAllEntries(expectedInHeaderMap));
 

For a single key:

 ANY_HEADER_KEY = "foo";
 assertThat(message, HeaderMatcher.hasKey(ANY_HEADER_KEY));
 

Author:

Alex Peters, Iwein Fuld

Method Summary

void	describeTo(org.hamcrest.Description description)
static org.hamcrest.Matcher<Message<?>>	hasAllHeaders(Map<String,?> entries)
static <T> org.hamcrest.Matcher<Message<?>>	hasCorrelationId(T value)
static org.hamcrest.Matcher<Message<?>>	hasExpirationDate(Date value)
static org.hamcrest.Matcher<Message<?>>	hasExpirationDate(org.hamcrest.Matcher<Long> matcher)
static <T> org.hamcrest.Matcher<Message<?>>	hasHeader(String key, org.hamcrest.Matcher<?> valueMatcher)
static <T> org.hamcrest.Matcher<Message<?>>	hasHeader(String key, T value)
static <T> org.hamcrest.Matcher<Message<?>>	hasHeaderKey(String key)
static <T> org.hamcrest.Matcher<Message<?>>	hasMessageId(T value)
static org.hamcrest.Matcher<Message<?>>	hasSequenceNumber(Integer value)
static org.hamcrest.Matcher<Message<?>>	hasSequenceNumber(org.hamcrest.Matcher<Integer> matcher)
static org.hamcrest.Matcher<Message<?>>	hasSequenceSize(Integer value)
static org.hamcrest.Matcher<Message<?>>	hasSequenceSize(org.hamcrest.Matcher<Integer> value)
static org.hamcrest.Matcher<Message<?>>	hasTimestamp(Date value)
static org.hamcrest.Matcher<Message<?>>	hasTimestamp(org.hamcrest.Matcher<Long> matcher)
boolean	matches(Object item) Method made final to prevent accidental override.
boolean	matchesSafely(Message<?> item) Subclasses should implement this.

Methods inherited from class org.hamcrest.BaseMatcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, toString

Methods inherited from class java.lang.Object

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

Method Detail

matchesSafely

public boolean matchesSafely(Message<?> item)

Subclasses should implement this. The item will already have been checked for the specific type and will never be null.

describeTo

public void describeTo(org.hamcrest.Description description)

hasHeader

public static <T> org.hamcrest.Matcher<Message<?>> hasHeader(String key,
                                                             T value)

hasHeader

public static <T> org.hamcrest.Matcher<Message<?>> hasHeader(String key,
                                                             org.hamcrest.Matcher<?> valueMatcher)

hasHeaderKey

public static <T> org.hamcrest.Matcher<Message<?>> hasHeaderKey(String key)

hasAllHeaders

public static org.hamcrest.Matcher<Message<?>> hasAllHeaders(Map<String,?> entries)

hasMessageId

public static <T> org.hamcrest.Matcher<Message<?>> hasMessageId(T value)

hasCorrelationId

public static <T> org.hamcrest.Matcher<Message<?>> hasCorrelationId(T value)

hasSequenceNumber

public static org.hamcrest.Matcher<Message<?>> hasSequenceNumber(Integer value)

hasSequenceNumber

public static org.hamcrest.Matcher<Message<?>> hasSequenceNumber(org.hamcrest.Matcher<Integer> matcher)

hasSequenceSize

public static org.hamcrest.Matcher<Message<?>> hasSequenceSize(Integer value)

hasSequenceSize

public static org.hamcrest.Matcher<Message<?>> hasSequenceSize(org.hamcrest.Matcher<Integer> value)

hasExpirationDate

public static org.hamcrest.Matcher<Message<?>> hasExpirationDate(Date value)

hasExpirationDate

public static org.hamcrest.Matcher<Message<?>> hasExpirationDate(org.hamcrest.Matcher<Long> matcher)

hasTimestamp

public static org.hamcrest.Matcher<Message<?>> hasTimestamp(Date value)

hasTimestamp

public static org.hamcrest.Matcher<Message<?>> hasTimestamp(org.hamcrest.Matcher<Long> matcher)

matches

public final boolean matches(Object item)

Method made final to prevent accidental override. If you need to override this, there's no point on extending TypeSafeMatcher. Instead, extend the BaseMatcher.