org.cthul.matchers.fluent8

Interface IterableFluent<T,Value extends Iterable<T>,BaseFluent,TheFluent extends BaseFluent,This extends IterableFluent<T,Value,BaseFluent,TheFluent,This>>

All Superinterfaces:

org.cthul.matchers.fluent.ext.ExtensibleFluentStep<Value,BaseFluent,TheFluent,This>, org.cthul.matchers.fluent.FluentStep<Value,BaseFluent>, ObjectFluent<Value,BaseFluent,TheFluent,This>

All Known Subinterfaces:

CollectionFluent<T,Value,BaseFluent,TheFluent,This>, CollectionFluent.AndChain<T,Value,TheFluent,This>, CollectionFluent.OrChain<T,Value,TheFluent,This>, IterableFluent.AndChain<T,Value,TheFluent,This>, IterableFluent.OrChain<T,Value,TheFluent,This>

All Known Implementing Classes:

CollectionFluent.Assert, CollectionFluent.Step, IterableFluent.Assert, IterableFluent.Step

public interface IterableFluent<T,Value extends Iterable<T>,BaseFluent,TheFluent extends BaseFluent,This extends IterableFluent<T,Value,BaseFluent,TheFluent,This>>
extends org.cthul.matchers.fluent.ext.ExtensibleFluentStep<Value,BaseFluent,TheFluent,This>, ObjectFluent<Value,BaseFluent,TheFluent,This>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IterableFluent.AndChain<T,Value extends Iterable<T>,TheFluent,This extends IterableFluent.AndChain<T,Value,TheFluent,This>>
static class	IterableFluent.Assert<T,Value extends Iterable<T>>
static interface	IterableFluent.OrChain<T,Value extends Iterable<T>,TheFluent,This extends IterableFluent.OrChain<T,Value,TheFluent,This>>
static class	IterableFluent.Step<T,Value extends Iterable<T>,TheFluent,This extends IterableFluent.Step<T,Value,TheFluent,This>>

Method Summary

Modifier and Type	Method and Description
IterableFluent.AndChain<T,Value,TheFluent,?>	all()
default <I> ObjectFluent.Step<I,TheFluent,?>	any()
default ObjectFluent.Step<Boolean,TheFluent,?>	anyBoolean()
default DoubleFluent.Step<Double,TheFluent,?>	anyDouble()
default IntegerFluent.Step<Integer,TheFluent,?>	anyInt()
default ComparableFluent.Step<Long,Long,TheFluent,?>	anyLong()
default StringFluent.Step<String,TheFluent,?>	anyString()
IterableFluent.AndChain<T,Value,TheFluent,?>	both()
IterableFluent.AndChain<T,Value,TheFluent,?>	both(org.hamcrest.Matcher<? super Value> matcher)
default TheFluent	contains(List<org.hamcrest.Matcher<? super T>> itemMatchers) Creates a matcher for Iterables that matches when a single pass over the examined Iterable yields a series of items, each satisfying the corresponding matcher in the specified list of matchers.
default TheFluent	contains(org.hamcrest.Matcher<? super T>... itemMatchers) Creates a matcher for Iterables that matches when a single pass over the examined Iterable yields a series of items, each satisfying the corresponding matcher in the specified matchers.
default TheFluent	contains(org.hamcrest.Matcher<? super T> itemMatcher) Creates a matcher for Iterables that matches when a single pass over the examined Iterable yields a single item that satisfies the specified matcher.
default TheFluent	contains(T... items) Creates a matcher for Iterables that matches when a single pass over the examined Iterable yields a series of items, each logically equal to the corresponding item in the specified items.
default TheFluent	containsInAnyOrder(Collection<org.hamcrest.Matcher<? super T>> itemMatchers) Creates an order agnostic matcher for Iterables that matches when a single pass over the examined Iterable yields a series of items, each satisfying one matcher anywhere in the specified collection of matchers.
default TheFluent	containsInAnyOrder(org.hamcrest.Matcher<? super T>... itemMatchers) Creates an order agnostic matcher for Iterables that matches when a single pass over the examined Iterable yields a series of items, each satisfying one matcher anywhere in the specified matchers.
default TheFluent	containsInAnyOrder(T... items) Creates an order agnostic matcher for Iterables that matches when a single pass over the examined Iterable yields a series of items, each logically equal to one item anywhere in the specified items.
default <I> ObjectFluent.Step<I,TheFluent,?>	each()
default ObjectFluent.Step<Boolean,TheFluent,?>	eachBoolean()
default DoubleFluent.Step<Double,TheFluent,?>	eachDouble()
default IntegerFluent.Step<Integer,TheFluent,?>	eachInt()
default ComparableFluent.Step<Long,Long,TheFluent,?>	eachLong()
default StringFluent.Step<String,TheFluent,?>	eachString()
IterableFluent.OrChain<T,Value,TheFluent,?>	either()
IterableFluent.OrChain<T,Value,TheFluent,?>	either(org.hamcrest.Matcher<? super Value> matcher)
default TheFluent	empty() Creates a matcher for Iterables matching examined iterables that yield no items.
default TheFluent	hasSize(int size) Creates a matcher for Iterables that matches when a single pass over the examined Iterable yields an item count that is equal to the specified size argument.
default IntegerFluent.Step<Integer,TheFluent,?>	size()

Methods inherited from interface org.cthul.matchers.fluent8.ObjectFluent

get, get, hasToString, hasToString, isIn, isIn, isOneOf, notNullValue, nullValue, sameInstance, theInstance

Methods inherited from interface org.cthul.matchers.fluent.ext.ExtensibleFluentStep

__, __, __, allOf, anyOf, as, as, equalTo, has, has, has, has, hasNot, hasNot, hasNot, hasNot, hasType, is, is, is, isA, isNot, isNot, isNot, noneOf, not, not, not, not, not

Method Detail

empty

default TheFluent empty()

Creates a matcher for Iterables matching examined iterables that yield no items.

For example:

assertThat(new ArrayList<String>(), is(emptyIterable()))

Returns:

fluent

See Also:

IsEmptyIterable.emptyIterable()

contains

default TheFluent contains(T... items)

Creates a matcher for Iterables that matches when a single pass over the examined Iterable yields a series of items, each logically equal to the corresponding item in the specified items. For a positive match, the examined iterable must be of the same length as the number of specified items.

For example:

assertThat(Arrays.asList("foo", "bar"), contains("foo", "bar"))

Parameters:

items - the items that must equal the items provided by an examined Iterable

Returns:

fluent

See Also:

IsIterableContainingInOrder.contains(java.lang.Object...)

contains

default TheFluent contains(org.hamcrest.Matcher<? super T> itemMatcher)

Creates a matcher for Iterables that matches when a single pass over the examined Iterable yields a single item that satisfies the specified matcher. For a positive match, the examined iterable must only yield one item.

For example:

assertThat(Arrays.asList("foo"), contains(equalTo("foo")))

Parameters:

itemMatcher - the matcher that must be satisfied by the single item provided by an examined Iterable

Returns:

fluent

See Also:

IsIterableContainingInOrder.contains(org.hamcrest.Matcher)

contains

default TheFluent contains(org.hamcrest.Matcher<? super T>... itemMatchers)

Creates a matcher for Iterables that matches when a single pass over the examined Iterable yields a series of items, each satisfying the corresponding matcher in the specified matchers. For a positive match, the examined iterable must be of the same length as the number of specified matchers.

For example:

assertThat(Arrays.asList("foo", "bar"), contains(equalTo("foo"), equalTo("bar")))

Parameters:

itemMatchers - the matchers that must be satisfied by the items provided by an examined Iterable

Returns:

fluent

See Also:

IsIterableContainingInOrder.contains(org.hamcrest.Matcher...)

contains

default TheFluent contains(List<org.hamcrest.Matcher<? super T>> itemMatchers)

Creates a matcher for Iterables that matches when a single pass over the examined Iterable yields a series of items, each satisfying the corresponding matcher in the specified list of matchers. For a positive match, the examined iterable must be of the same length as the specified list of matchers.

For example:

assertThat(Arrays.asList("foo", "bar"), contains(Arrays.asList(equalTo("foo"), equalTo("bar"))))

Parameters:

itemMatchers - a list of matchers, each of which must be satisfied by the corresponding item provided by an examined Iterable

Returns:

fluent

See Also:

IsIterableContainingInOrder.contains(java.util.List)

containsInAnyOrder

default TheFluent containsInAnyOrder(org.hamcrest.Matcher<? super T>... itemMatchers)

Creates an order agnostic matcher for Iterables that matches when a single pass over the examined Iterable yields a series of items, each satisfying one matcher anywhere in the specified matchers. For a positive match, the examined iterable must be of the same length as the number of specified matchers.

N.B. each of the specified matchers will only be used once during a given examination, so be careful when specifying matchers that may be satisfied by more than one entry in an examined iterable.

For example:

assertThat(Arrays.asList("foo", "bar"), containsInAnyOrder(equalTo("bar"), equalTo("foo")))

Parameters:

itemMatchers - a list of matchers, each of which must be satisfied by an item provided by an examined Iterable

Returns:

fluent

See Also:

IsIterableContainingInAnyOrder.containsInAnyOrder(org.hamcrest.Matcher...)

containsInAnyOrder

default TheFluent containsInAnyOrder(T... items)

Creates an order agnostic matcher for Iterables that matches when a single pass over the examined Iterable yields a series of items, each logically equal to one item anywhere in the specified items. For a positive match, the examined iterable must be of the same length as the number of specified items.

N.B. each of the specified items will only be used once during a given examination, so be careful when specifying items that may be equal to more than one entry in an examined iterable.

For example:

assertThat(Arrays.asList("foo", "bar"), containsInAnyOrder("bar", "foo"))

Parameters:

items - the items that must equal the items provided by an examined Iterable in any order

Returns:

fluent

See Also:

IsIterableContainingInAnyOrder.containsInAnyOrder(java.lang.Object...)

containsInAnyOrder

default TheFluent containsInAnyOrder(Collection<org.hamcrest.Matcher<? super T>> itemMatchers)

Creates an order agnostic matcher for Iterables that matches when a single pass over the examined Iterable yields a series of items, each satisfying one matcher anywhere in the specified collection of matchers. For a positive match, the examined iterable must be of the same length as the specified collection of matchers.

N.B. each matcher in the specified collection will only be used once during a given examination, so be careful when specifying matchers that may be satisfied by more than one entry in an examined iterable.

For example:

assertThat(Arrays.asList("foo", "bar"), containsInAnyOrder(Arrays.asList(equalTo("bar"), equalTo("foo"))))

Parameters:

itemMatchers - a list of matchers, each of which must be satisfied by an item provided by an examined Iterable

Returns:

fluent

See Also:

IsIterableContainingInAnyOrder.containsInAnyOrder(java.util.Collection)

hasSize

default TheFluent hasSize(int size)

Creates a matcher for Iterables that matches when a single pass over the examined Iterable yields an item count that is equal to the specified size argument.

For example:

assertThat(Arrays.asList("foo", "bar"), iterableWithSize(2))

Parameters:

size - the number of items that should be yielded by an examined Iterable

Returns:

fluent

See Also:

IsIterableWithSize.iterableWithSize(int)

size

default IntegerFluent.Step<Integer,TheFluent,?> size()

Returns:

integer fluent step step

See Also:

IterableSizeAdapter.size()

any

default <I> ObjectFluent.Step<I,TheFluent,?> any()

Returns:

object fluent step step

See Also:

AnyOfAdapter.any()

anyString

default StringFluent.Step<String,TheFluent,?> anyString()

Returns:

string fluent step step

See Also:

AnyOfAdapter.anyString()

anyBoolean

default ObjectFluent.Step<Boolean,TheFluent,?> anyBoolean()

Returns:

object fluent step step

See Also:

AnyOfAdapter.anyBoolean()

anyDouble

default DoubleFluent.Step<Double,TheFluent,?> anyDouble()

Returns:

double fluent step step

See Also:

AnyOfAdapter.anyDouble()

anyInt

default IntegerFluent.Step<Integer,TheFluent,?> anyInt()

Returns:

integer fluent step step

See Also:

AnyOfAdapter.anyInt()

anyLong

default ComparableFluent.Step<Long,Long,TheFluent,?> anyLong()

Returns:

comparable fluent step step

See Also:

AnyOfAdapter.anyLong()

each

default <I> ObjectFluent.Step<I,TheFluent,?> each()

Returns:

object fluent step step

See Also:

EachOfAdapter.each()

eachString

default StringFluent.Step<String,TheFluent,?> eachString()

Returns:

string fluent step step

See Also:

EachOfAdapter.eachString()

eachBoolean

default ObjectFluent.Step<Boolean,TheFluent,?> eachBoolean()

Returns:

object fluent step step

See Also:

EachOfAdapter.eachBoolean()

eachDouble

default DoubleFluent.Step<Double,TheFluent,?> eachDouble()

Returns:

double fluent step step

See Also:

EachOfAdapter.eachDouble()

eachInt

default IntegerFluent.Step<Integer,TheFluent,?> eachInt()

Returns:

integer fluent step step

See Also:

EachOfAdapter.eachInt()

eachLong

default ComparableFluent.Step<Long,Long,TheFluent,?> eachLong()

Returns:

comparable fluent step step

See Also:

EachOfAdapter.eachLong()

either

IterableFluent.OrChain<T,Value,TheFluent,?> either()

Specified by:

either in interface org.cthul.matchers.fluent.ext.ExtensibleFluentStep<Value extends Iterable<T>,BaseFluent,TheFluent extends BaseFluent,This extends IterableFluent<T,Value,BaseFluent,TheFluent,This>>

Specified by:

either in interface org.cthul.matchers.fluent.FluentStep<Value extends Iterable<T>,BaseFluent>

Specified by:

either in interface ObjectFluent<Value extends Iterable<T>,BaseFluent,TheFluent extends BaseFluent,This extends IterableFluent<T,Value,BaseFluent,TheFluent,This>>

either

IterableFluent.OrChain<T,Value,TheFluent,?> either(org.hamcrest.Matcher<? super Value> matcher)

Specified by:

either in interface org.cthul.matchers.fluent.ext.ExtensibleFluentStep<Value extends Iterable<T>,BaseFluent,TheFluent extends BaseFluent,This extends IterableFluent<T,Value,BaseFluent,TheFluent,This>>

Specified by:

either in interface org.cthul.matchers.fluent.FluentStep<Value extends Iterable<T>,BaseFluent>

Specified by:

either in interface ObjectFluent<Value extends Iterable<T>,BaseFluent,TheFluent extends BaseFluent,This extends IterableFluent<T,Value,BaseFluent,TheFluent,This>>

both

IterableFluent.AndChain<T,Value,TheFluent,?> both()

Specified by:

both in interface org.cthul.matchers.fluent.ext.ExtensibleFluentStep<Value extends Iterable<T>,BaseFluent,TheFluent extends BaseFluent,This extends IterableFluent<T,Value,BaseFluent,TheFluent,This>>

Specified by:

both in interface org.cthul.matchers.fluent.FluentStep<Value extends Iterable<T>,BaseFluent>

Specified by:

both in interface ObjectFluent<Value extends Iterable<T>,BaseFluent,TheFluent extends BaseFluent,This extends IterableFluent<T,Value,BaseFluent,TheFluent,This>>

both

IterableFluent.AndChain<T,Value,TheFluent,?> both(org.hamcrest.Matcher<? super Value> matcher)

Specified by:

both in interface org.cthul.matchers.fluent.ext.ExtensibleFluentStep<Value extends Iterable<T>,BaseFluent,TheFluent extends BaseFluent,This extends IterableFluent<T,Value,BaseFluent,TheFluent,This>>

Specified by:

both in interface org.cthul.matchers.fluent.FluentStep<Value extends Iterable<T>,BaseFluent>

Specified by:

both in interface ObjectFluent<Value extends Iterable<T>,BaseFluent,TheFluent extends BaseFluent,This extends IterableFluent<T,Value,BaseFluent,TheFluent,This>>

all

IterableFluent.AndChain<T,Value,TheFluent,?> all()

Specified by:

all in interface org.cthul.matchers.fluent.ext.ExtensibleFluentStep<Value extends Iterable<T>,BaseFluent,TheFluent extends BaseFluent,This extends IterableFluent<T,Value,BaseFluent,TheFluent,This>>

Specified by:

all in interface org.cthul.matchers.fluent.FluentStep<Value extends Iterable<T>,BaseFluent>

Specified by:

all in interface ObjectFluent<Value extends Iterable<T>,BaseFluent,TheFluent extends BaseFluent,This extends IterableFluent<T,Value,BaseFluent,TheFluent,This>>