IterableAssert (AssertJ fluent assertions 2.9.1 API)

java.lang.Object
- org.assertj.core.api.AbstractAssert<SELF,ACTUAL>
- - org.assertj.core.api.AbstractIterableAssert<SELF,ACTUAL,ELEMENT,ELEMENT_ASSERT>
  - - org.assertj.core.api.FactoryBasedNavigableIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    - - org.assertj.core.api.IterableAssert<ELEMENT>

Type Parameters:
ELEMENT - the type of elements of the "actual" value.

All Implemented Interfaces:

Assert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>>, Descriptable<IterableAssert<ELEMENT>>, EnumerableAssert<IterableAssert<ELEMENT>,ELEMENT>, ExtensionPoints<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>>, ObjectEnumerableAssert<IterableAssert<ELEMENT>,ELEMENT>
```
public class IterableAssert<ELEMENT>
extends FactoryBasedNavigableIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
```
Assertion methods for Iterable.
To create an instance of this class, invoke Assertions.assertThat(Iterable).

Author:

Yvonne Wang, Alex Ruiz, Matthieu Baechler, Joel Costigliola, Mikhail Mazursky, Julien Meddah

Field Summary
- Fields inherited from class org.assertj.core.api.AbstractIterableAssert
  iterables
- Fields inherited from class org.assertj.core.api.AbstractAssert
  actual, info, myself

Constructor Summary

Constructors
Constructor and Description

IterableAssert(Iterable<? extends ELEMENT> actual)

IterableAssert(Iterator<? extends ELEMENT> actual)

Constructors
Constructor and Description
`IterableAssert(Iterable<? extends ELEMENT> actual)`
`IterableAssert(Iterator<? extends ELEMENT> actual)`

Method Summary

Methods
Modifier and Type	Method and Description
`IterableAssert<ELEMENT>`	`contains(ELEMENT... values)` Verifies that the actual group contains the given values, in any order.
`IterableAssert<ELEMENT>`	`containsExactly(ELEMENT... values)` Verifies that the actual group contains exactly the given values and nothing else, in order. This assertion should only be used with groups that have a consistent iteration order (i.e.
`IterableAssert<ELEMENT>`	`containsExactlyInAnyOrder(ELEMENT... values)` Verifies that the actual group contains exactly the given values and nothing else, in any order.
`IterableAssert<ELEMENT>`	`containsOnly(ELEMENT... values)` Verifies that the actual group contains only the given values and nothing else, in any order and ignoring duplicates (i.e.
`IterableAssert<ELEMENT>`	`containsOnlyOnce(ELEMENT... values)` Verifies that the actual group contains the given values only once.
`IterableAssert<ELEMENT>`	`containsSequence(ELEMENT... sequence)` Verifies that the actual group contains the given sequence in the correct order and without extra values between the sequence values.
`IterableAssert<ELEMENT>`	`containsSubsequence(ELEMENT... sequence)` Verifies that the actual group contains the given subsequence in the correct order (possibly with other values between them).
`IterableAssert<ELEMENT>`	`doesNotContain(ELEMENT... values)` Verifies that the actual group does not contain the given values.
`IterableAssert<ELEMENT>`	`doesNotContainSequence(ELEMENT... sequence)` Verifies that the actual group does not contain the given sequence, a sequence is defined by an ordered group of values without extra values between them.
`IterableAssert<ELEMENT>`	`doesNotContainSubsequence(ELEMENT... sequence)` Verifies that the actual group does not contain the given subsequence, a subsequence is defined by an ordered group of values with possibly extra values between them.
`IterableAssert<ELEMENT>`	`endsWith(ELEMENT first, ELEMENT... rest)` Verifies that the actual group ends with the given sequence of objects, without any other objects between them.
`IterableAssert<ELEMENT>`	`isEqualTo(Object expected)` Verifies that the actual value is equal to the given one.
`IterableAssert<ELEMENT>`	`isExactlyInstanceOf(Class<?> type)` Verifies that the actual value is exactly an instance of the given type.
`IterableAssert<ELEMENT>`	`isInstanceOf(Class<?> type)` Verifies that the actual value is an instance of the given type.
`IterableAssert<ELEMENT>`	`isInstanceOfAny(Class<?>... types)` Verifies that the actual value is an instance of any of the given types.
`IterableAssert<ELEMENT>`	`isNotExactlyInstanceOf(Class<?> type)` Verifies that the actual value is not exactly an instance of given type.
`IterableAssert<ELEMENT>`	`isNotInstanceOf(Class<?> type)` Verifies that the actual value is not an instance of the given type.
`IterableAssert<ELEMENT>`	`isNotInstanceOfAny(Class<?>... types)` Verifies that the actual value is not an instance of any of the given types.
`IterableAssert<ELEMENT>`	`isNotOfAnyClassIn(Class<?>... types)` Verifies that the actual value type is not in given types.
`IterableAssert<ELEMENT>`	`isNotSameAs(Object expected)` Verifies that the actual value is not the same as the given one, ie using == comparison.
`IterableAssert<ELEMENT>`	`isOfAnyClassIn(Class<?>... types)` Verifies that the actual value type is in given types.
`IterableAssert<ELEMENT>`	`isSameAs(Object expected)` Verifies that the actual value is the same as the given one, ie using == comparison.
`IterableAssert<ELEMENT>`	`isSubsetOf(ELEMENT... values)` Verifies that all the elements of actual are present in the given values.
`IterableAssert<ELEMENT>`	`startsWith(ELEMENT... sequence)` Verifies that the actual group starts with the given sequence of objects, without any other objects between them.

Methods inherited from class org.assertj.core.api.FactoryBasedNavigableIterableAssert
toAssert

Methods inherited from class org.assertj.core.api.AbstractIterableAssert
are, areAtLeast, areAtLeastOne, areAtMost, areExactly, areNot, as, as, containsAll, containsAnyElementsOf, containsAnyOf, containsExactlyElementsOf, containsExactlyInAnyOrderElementsOf, containsNull, containsOnlyElementsOf, containsOnlyNulls, containsSequence, containsSubsequence, describedAs, describedAs, doesNotContainAnyElementsOf, doesNotContainNull, doesNotContainSequence, doesNotContainSubsequence, doesNotHave, doesNotHaveAnyElementsOfTypes, doesNotHaveDuplicates, doesNotHaveSameClassAs, doNotHave, element, endsWith, extracting, extracting, extracting, extracting, extractingResultOf, extractingResultOf, filteredOn, filteredOn, filteredOn, filteredOnNull, first, flatExtracting, flatExtracting, flatExtracting, has, hasAtLeastOneElementOfType, hasOnlyElementsOfType, hasOnlyElementsOfTypes, hasSameClassAs, hasSameElementsAs, hasSameSizeAs, hasSameSizeAs, hasSize, hasToString, have, haveAtLeast, haveAtLeastOne, haveAtMost, haveExactly, inBinary, inHexadecimal, is, isEmpty, isIn, isIn, isNot, isNotEmpty, isNotEqualTo, isNotIn, isNotIn, isNotNull, isNullOrEmpty, isSubsetOf, last, navigationDescription, newListAssertInstance, overridingErrorMessage, size, toLazyIterable, usingComparator, usingComparator, usingComparatorForElementFieldsWithNames, usingComparatorForElementFieldsWithType, usingComparatorForType, usingComparisonStrategy, usingDefaultComparator, usingDefaultElementComparator, usingElementComparator, usingElementComparatorIgnoringFields, usingElementComparatorOnFields, usingFieldByFieldElementComparator, usingRecursiveFieldByFieldElementComparator, withFailMessage, withThreadDumpOnError

Methods inherited from class org.assertj.core.api.AbstractAssert
asList, asString, descriptionText, equals, failWithMessage, getWritableAssertionInfo, hashCode, hasSameHashCodeAs, isNull, setCustomRepresentation, throwAssertionError, withRepresentation

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IterableAssert
```
public IterableAssert(Iterable<? extends ELEMENT> actual)
```
  - IterableAssert
```
public IterableAssert(Iterator<? extends ELEMENT> actual)
```
- Method Detail
  - isEqualTo
```
public IterableAssert<ELEMENT> isEqualTo(Object expected)
```
    Description copied from class: AbstractAssert
    Verifies that the actual value is equal to the given one.
    Example:
```
 // assertions will pass
 assertThat("abc").isEqualTo("abc");
 assertThat(new HashMap<String, Integer>()).isEqualTo(new HashMap<String, Integer>());
 
 // assertions will fail
 assertThat("abc").isEqualTo("123");
 assertThat(new ArrayList<String>()).isEqualTo(1);
```
    Specified by:
    
    isEqualTo in interface Assert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>>
    
    Overrides:
    
    isEqualTo in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    expected - the given value to compare the actual value to.
    
    Returns:
    this assertion object.
  - isInstanceOf
```
public IterableAssert<ELEMENT> isInstanceOf(Class<?> type)
```
    Description copied from class: AbstractAssert
    Verifies that the actual value is an instance of the given type.
    Example:
```
 // assertions will pass
 assertThat("abc").isInstanceOf(String.class);
 assertThat(new HashMap<String, Integer>()).isInstanceOf(HashMap.class);
 assertThat(new HashMap<String, Integer>()).isInstanceOf(Map.class);
 
 // assertions will fail
 assertThat(1).isInstanceOf(String.class);
 assertThat(new ArrayList<String>()).isInstanceOf(LinkedList.class);
```
    Specified by:
    
    isInstanceOf in interface Assert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>>
    
    Overrides:
    
    isInstanceOf in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    type - the type to check the actual value against.
    
    Returns:
    this assertion object.
  - isInstanceOfAny
```
public IterableAssert<ELEMENT> isInstanceOfAny(Class<?>... types)
```
    Description copied from class: AbstractAssert
    Verifies that the actual value is an instance of any of the given types.
    Example:
```
 // assertions will pass
 assertThat("abc").isInstanceOfAny(String.class, Integer.class);
 assertThat(new ArrayList<String>()).isInstanceOfAny(LinkedList.class, ArrayList.class);
 assertThat(new HashMap<String, Integer>()).isInstanceOfAny(TreeMap.class, Map.class);
 
 // assertions will fail
 assertThat(1).isInstanceOfAny(Double.class, Float.class);
 assertThat(new ArrayList<String>()).isInstanceOfAny(LinkedList.class, Vector.class);
```
    Specified by:
    
    isInstanceOfAny in interface Assert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>>
    
    Overrides:
    
    isInstanceOfAny in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    types - the types to check the actual value against.
    
    Returns:
    this assertion object.
  - isOfAnyClassIn
```
public IterableAssert<ELEMENT> isOfAnyClassIn(Class<?>... types)
```
    Description copied from class: AbstractAssert
    Verifies that the actual value type is in given types.
    Example:
```
 // assertions will pass
 assertThat(new HashMap<String, Integer>()).isOfAnyClassIn(HashMap.class, TreeMap.class);
 assertThat(new ArrayList<String>()).isOfAnyClassIn(ArrayList.class, LinkedList.class);
 
 // assertions will fail
 assertThat(new HashMap<String, Integer>()).isOfAnyClassIn(TreeMap.class, Map.class);
 assertThat(new ArrayList<String>()).isOfAnyClassIn(LinkedList.class, List.class);
```
    Specified by:
    
    isOfAnyClassIn in interface Assert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>>
    
    Overrides:
    
    isOfAnyClassIn in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    types - the types to check the actual value against.
    
    Returns:
    this assertion object.
  - isExactlyInstanceOf
```
public IterableAssert<ELEMENT> isExactlyInstanceOf(Class<?> type)
```
    Description copied from class: AbstractAssert
    Verifies that the actual value is exactly an instance of the given type.
    Example:
```
 // assertions will pass
 assertThat("abc").isExactlyInstanceOf(String.class);
 assertThat(new ArrayList<String>()).isExactlyInstanceOf(ArrayList.class);
 assertThat(new HashMap<String, Integer>()).isExactlyInstanceOf(HashMap.class);
 
 // assertions will fail
 assertThat(1).isExactlyInstanceOf(String.class);
 assertThat(new ArrayList<String>()).isExactlyInstanceOf(List.class);
 assertThat(new HashMap<String, Integer>()).isExactlyInstanceOf(Map.class);
```
    Specified by:
    
    isExactlyInstanceOf in interface Assert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>>
    
    Overrides:
    
    isExactlyInstanceOf in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    type - the type to check the actual value against.
    
    Returns:
    this assertion object.
  - isNotInstanceOf
```
public IterableAssert<ELEMENT> isNotInstanceOf(Class<?> type)
```
    Description copied from class: AbstractAssert
    Verifies that the actual value is not an instance of the given type.
    Example:
```
 // assertions will pass
 assertThat(1).isNotInstanceOf(Double.class);
 assertThat(new ArrayList<String>()).isNotInstanceOf(LinkedList.class);
 
 // assertions will fail
 assertThat("abc").isNotInstanceOf(String.class);
 assertThat(new HashMap<String, Integer>()).isNotInstanceOf(HashMap.class);
 assertThat(new HashMap<String, Integer>()).isNotInstanceOf(Map.class);
```
    Specified by:
    
    isNotInstanceOf in interface Assert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>>
    
    Overrides:
    
    isNotInstanceOf in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    type - the type to check the actual value against.
    
    Returns:
    this assertion object.
  - isNotInstanceOfAny
```
public IterableAssert<ELEMENT> isNotInstanceOfAny(Class<?>... types)
```
    Description copied from class: AbstractAssert
    Verifies that the actual value is not an instance of any of the given types.
    Example:
```
 // assertions will pass
 assertThat(1).isNotInstanceOfAny(Double.class, Float.class);
 assertThat(new ArrayList<String>()).isNotInstanceOfAny(LinkedList.class, Vector.class);
 
 // assertions will fail
 assertThat(1).isNotInstanceOfAny(Double.class, Integer.class);
 assertThat(new ArrayList<String>()).isNotInstanceOfAny(LinkedList.class, ArrayList.class);
 assertThat(new HashMap<String, Integer>()).isNotInstanceOfAny(TreeMap.class, Map.class);
```
    Specified by:
    
    isNotInstanceOfAny in interface Assert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>>
    
    Overrides:
    
    isNotInstanceOfAny in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    types - the types to check the actual value against.
    
    Returns:
    this assertion object.
  - isNotOfAnyClassIn
```
public IterableAssert<ELEMENT> isNotOfAnyClassIn(Class<?>... types)
```
    Description copied from class: AbstractAssert
    Verifies that the actual value type is not in given types.
    Example:
```
 // assertions will pass
 assertThat(new HashMap<String, Integer>()).isNotOfAnyClassIn(Map.class, TreeMap.class);
 assertThat(new ArrayList<String>()).isNotOfAnyClassIn(LinkedList.class, List.class);
 
 // assertions will fail
 assertThat(new HashMap<String, Integer>()).isNotOfAnyClassIn(HashMap.class, TreeMap.class);
 assertThat(new ArrayList<String>()).isNotOfAnyClassIn(ArrayList.class, LinkedList.class);
```
    Specified by:
    
    isNotOfAnyClassIn in interface Assert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>>
    
    Overrides:
    
    isNotOfAnyClassIn in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    types - the types to check the actual value against.
    
    Returns:
    this assertion object.
  - isNotExactlyInstanceOf
```
public IterableAssert<ELEMENT> isNotExactlyInstanceOf(Class<?> type)
```
    Description copied from class: AbstractAssert
    Verifies that the actual value is not exactly an instance of given type.
    Example:
```
 // assertions will pass
 assertThat(1).isNotExactlyInstanceOf(String.class);
 assertThat(new ArrayList<String>()).isNotExactlyInstanceOf(List.class);
 assertThat(new HashMap<String, Integer>()).isNotExactlyInstanceOf(Map.class);
 
 // assertions will fail
 assertThat("abc").isNotExactlyInstanceOf(String.class);
 assertThat(new ArrayList<String>()).isNotExactlyInstanceOf(ArrayList.class);
 assertThat(new HashMap<String, Integer>()).isNotExactlyInstanceOf(HashMap.class);
```
    Specified by:
    
    isNotExactlyInstanceOf in interface Assert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>>
    
    Overrides:
    
    isNotExactlyInstanceOf in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    type - the type to check the actual value against.
    
    Returns:
    this assertion object.
  - isSameAs
```
public IterableAssert<ELEMENT> isSameAs(Object expected)
```
    Description copied from class: AbstractAssert
    Verifies that the actual value is the same as the given one, ie using == comparison.
    Example:
```
 // Name is a class with first and last fields, two Names are equals if both first and last are equals.
 Name tyrion = new Name("Tyrion", "Lannister");
 Name alias  = tyrion;
 Name clone  = new Name("Tyrion", "Lannister");
 
 // assertions succeed:
 assertThat(tyrion).isSameAs(alias)
                   .isEqualTo(clone);
                      
 // assertion fails:
 assertThat(tyrion).isSameAs(clone);
```
    Specified by:
    
    isSameAs in interface Assert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>>
    
    Overrides:
    
    isSameAs in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    expected - the given value to compare the actual value to.
    
    Returns:
    this assertion object.
  - isNotSameAs
```
public IterableAssert<ELEMENT> isNotSameAs(Object expected)
```
    Description copied from class: AbstractAssert
    Verifies that the actual value is not the same as the given one, ie using == comparison.
    Example:
```
 // Name is a class with first and last fields, two Names are equals if both first and last are equals.
 Name tyrion = new Name("Tyrion", "Lannister");
 Name alias  = tyrion;
 Name clone  = new Name("Tyrion", "Lannister");
 
 // assertions succeed:
 assertThat(clone).isNotSameAs(tyrion)
                  .isEqualTo(tyrion);
                      
 // assertion fails:
 assertThat(alias).isNotSameAs(tyrion);
```
    Specified by:
    
    isNotSameAs in interface Assert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>>
    
    Overrides:
    
    isNotSameAs in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    expected - the given value to compare the actual value to.
    
    Returns:
    this assertion object.
  - startsWith
```
@SafeVarargs
public final IterableAssert<ELEMENT> startsWith(ELEMENT... sequence)
```
    Description copied from class: AbstractIterableAssert
    Verifies that the actual group starts with the given sequence of objects, without any other objects between them. Similar to ObjectEnumerableAssert.containsSequence(Object...), but it also verifies that the first element in the sequence is also first element of the actual group.
    Example:
```
 // an Iterable is used in the example but it would also work with an array
 Iterable<String> abc = newArrayList("a", "b", "c");

 // assertions will pass
 assertThat(abc).startsWith("a")
                .startsWith("a", "b");
 
 // assertion will fail
 assertThat(abc).startsWith("c");
```
    Specified by:
    
    startsWith in interface ObjectEnumerableAssert<IterableAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    startsWith in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    sequence - the sequence of objects to look for.
    
    Returns:
    this assertion object.
  - contains
```
@SafeVarargs
public final IterableAssert<ELEMENT> contains(ELEMENT... values)
```
    Description copied from class: AbstractIterableAssert
    Verifies that the actual group contains the given values, in any order.
    Example:
```
 Iterable<String> abc = newArrayList("a", "b", "c");
 
 // assertions will pass
 assertThat(abc).contains("b", "a");
 assertThat(abc).contains("b", "a", "b");
 
 // assertion will fail
 assertThat(abc).contains("d");
```
    If you want to specify the elements to check with an Iterable, use containsAll(Iterable) instead.
    Specified by:
    
    contains in interface ObjectEnumerableAssert<IterableAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    contains in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    values - the given values.
    
    Returns:
    this assertion object.
  - containsOnly
```
@SafeVarargs
public final IterableAssert<ELEMENT> containsOnly(ELEMENT... values)
```
    Description copied from class: AbstractIterableAssert
    Verifies that the actual group contains only the given values and nothing else, in any order and ignoring duplicates (i.e. once a value is found, its duplicates are also considered found).
    If you need to check exactly the elements and their duplicates use:
    - containsExactly(Object...) if the order does matter
    - containsExactlyInAnyOrder(Object...) if the order does not matter
    Example:
```
 Iterable<String> abc = newArrayList("a", "b", "c");

 // assertions will pass as order does not matter
 assertThat(abc).containsOnly("c", "b", "a");
 // duplicates are ignored   
 assertThat(abc).containsOnly("a", "a", "b", "c", "c");
 // ... on both actual and expected values 
 assertThat(asList("a", "a", "b")).containsOnly("a", "b")
                                  .containsOnly("a", "a", "b", "b");
 
 // assertion will fail because "c" is missing in the given values
 assertThat(abc).containsOnly("a", "b");
 // assertion will fail because "d" is missing in abc (use isSubsetOf if you want this assertion to pass)
 assertThat(abc).containsOnly("a", "b", "c", "d");
```
    If you need to check that actual is a subset of the given values, use ObjectEnumerableAssert.isSubsetOf(Object...).
    If you want to specify the elements to check with an Iterable, use containsOnlyElementsOf(Iterable) instead.
    Specified by:
    
    containsOnly in interface ObjectEnumerableAssert<IterableAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    containsOnly in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    values - the given values.
    
    Returns:
    this assertion object.
  - containsOnlyOnce
```
@SafeVarargs
public final IterableAssert<ELEMENT> containsOnlyOnce(ELEMENT... values)
```
    Description copied from class: AbstractIterableAssert
    Verifies that the actual group contains the given values only once.
    Examples :
```
 // lists are used in the examples but it would also work with arrays
 
 // assertions will pass
 assertThat(newArrayList("winter", "is", "coming")).containsOnlyOnce("winter");
 assertThat(newArrayList("winter", "is", "coming")).containsOnlyOnce("coming", "winter");
 
 // assertions will fail
 assertThat(newArrayList("winter", "is", "coming")).containsOnlyOnce("Lannister");
 assertThat(newArrayList("Arya", "Stark", "daughter", "of", "Ned", "Stark")).containsOnlyOnce("Stark");
 assertThat(newArrayList("Arya", "Stark", "daughter", "of", "Ned", "Stark")).containsOnlyOnce("Stark", "Lannister", "Arya");
```
    Specified by:
    
    containsOnlyOnce in interface ObjectEnumerableAssert<IterableAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    containsOnlyOnce in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    values - the given values.
    
    Returns:
    this assertion object.
  - containsExactly
```
@SafeVarargs
public final IterableAssert<ELEMENT> containsExactly(ELEMENT... values)
```
    Description copied from class: AbstractIterableAssert
    Verifies that the actual group contains exactly the given values and nothing else, in order.
    This assertion should only be used with groups that have a consistent iteration order (i.e. don't use it with HashSet, prefer ObjectEnumerableAssert.containsOnly(Object...) in that case).
    Example:
```
 // an Iterable is used in the example but it would also work with an array
 Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya);
 
 // assertion will pass
 assertThat(elvesRings).containsExactly(vilya, nenya, narya);
 
 // assertion will fail as actual and expected order differ
 assertThat(elvesRings).containsExactly(nenya, vilya, narya);
```
    If you want to specify the elements to check with an Iterable, use containsExactlyElementsOf(Iterable) instead.
    Specified by:
    
    containsExactly in interface ObjectEnumerableAssert<IterableAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    containsExactly in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    values - the given values.
    
    Returns:
    this assertion object.
  - containsExactlyInAnyOrder
```
@SafeVarargs
public final IterableAssert<ELEMENT> containsExactlyInAnyOrder(ELEMENT... values)
```
    Description copied from class: AbstractIterableAssert
    Verifies that the actual group contains exactly the given values and nothing else, in any order.
    
    Example:
```
 // an Iterable is used in the example but it would also work with an array
 Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya, vilya);

 // assertion will pass
 assertThat(elvesRings).containsExactlyInAnyOrder(vilya, vilya, nenya, narya);

 // assertion will fail as vilya is contained twice in elvesRings.
 assertThat(elvesRings).containsExactlyInAnyOrder(nenya, vilya, narya);
```
    If you want to specify the elements to check with an Iterable, use containsExactlyInAnyOrderElementsOf(Iterable) instead.
    Specified by:
    
    containsExactlyInAnyOrder in interface ObjectEnumerableAssert<IterableAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    containsExactlyInAnyOrder in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    values - the given values.
    
    Returns:
    this assertion object.
  - isSubsetOf
```
@SafeVarargs
public final IterableAssert<ELEMENT> isSubsetOf(ELEMENT... values)
```
    Description copied from class: AbstractIterableAssert
    Verifies that all the elements of actual are present in the given values.
    Example:
```
 // an Iterable is used in the example but it would also work with an array
 Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya);
 
 // assertions will pass:
 assertThat(elvesRings).isSubsetOf(vilya, nenya, narya)
                       .isSubsetOf(vilya, nenya, narya, dwarfRing);
 
 // assertions will fail:
 assertThat(elvesRings).isSubsetOf(vilya, nenya);
 assertThat(elvesRings).isSubsetOf(vilya, nenya, dwarfRing);
```
    If you want to specify the set of elements an Iterable, use isSubsetOf(Iterable) instead.
    Specified by:
    
    isSubsetOf in interface ObjectEnumerableAssert<IterableAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    isSubsetOf in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    values - the values that should be used for checking the elements of actual.
    
    Returns:
    this assertion object.
  - containsSequence
```
@SafeVarargs
public final IterableAssert<ELEMENT> containsSequence(ELEMENT... sequence)
```
    Description copied from class: AbstractIterableAssert
    Verifies that the actual group contains the given sequence in the correct order and without extra values between the sequence values.
    Use ObjectEnumerableAssert.containsSubsequence(Object...) to allow values between the expected sequence values.
    Example:
```
 // an Iterable is used in the example but it would also work with an array
 Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya);
 
 // assertions will pass
 assertThat(elvesRings).containsSequence(vilya, nenya)
                       .containsSequence(nenya, narya);
 
 // assertions will fail, the elements order is correct but there is a value between them (nenya) 
 assertThat(elvesRings).containsSequence(vilya, narya);  
 assertThat(elvesRings).containsSequence(nenya, vilya);
```
    If you want to specify the sequence to check with an Iterable, use containsSequence(Iterable) instead.
    Specified by:
    
    containsSequence in interface ObjectEnumerableAssert<IterableAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    containsSequence in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    sequence - the sequence of objects to look for.
    
    Returns:
    this assertion object.
  - doesNotContainSequence
```
@SafeVarargs
public final IterableAssert<ELEMENT> doesNotContainSequence(ELEMENT... sequence)
```
    Description copied from class: AbstractIterableAssert
    Verifies that the actual group does not contain the given sequence, a sequence is defined by an ordered group of values without extra values between them.
    Use ObjectEnumerableAssert.doesNotContainSubsequence(Object...) to also ensure the sequence does not exist with values between the expected sequence values.
    Example:
```
 // an Iterable is used in the example but it would also work with an array
 Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya);

 // assertions will pass, the elements order is correct but there is a value between them (nenya)
 assertThat(elvesRings).doesNotContainSequence(vilya, narya)
                       .doesNotContainSequence(nenya, vilya);

 // assertions will fail
 assertThat(elvesRings).doesNotContainSequence(vilya, nenya);
 assertThat(elvesRings).doesNotContainSequence(nenya, narya);
```
    If you want to specify the sequence not to find with an Iterable, use doesNotContainSequence(Iterable) instead.
    Specified by:
    
    doesNotContainSequence in interface ObjectEnumerableAssert<IterableAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    doesNotContainSequence in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    sequence - the sequence of objects to look for.
    
    Returns:
    this assertion object.
  - containsSubsequence
```
@SafeVarargs
public final IterableAssert<ELEMENT> containsSubsequence(ELEMENT... sequence)
```
    Description copied from class: AbstractIterableAssert
    Verifies that the actual group contains the given subsequence in the correct order (possibly with other values between them).
    Example:
```
 // an Iterable is used in the example but it would also work with an array
 Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya);
 
 // assertions will pass
 assertThat(elvesRings).containsSubsequence(vilya, nenya)
                       .containsSubsequence(vilya, narya);
 
 // assertion will fail
 assertThat(elvesRings).containsSubsequence(nenya, vilya);
```
    If you want to specify the elements of the subsequence to check with an Iterable, use containsSubsequence(Iterable) instead.
    Specified by:
    
    containsSubsequence in interface ObjectEnumerableAssert<IterableAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    containsSubsequence in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    sequence - the sequence of objects to look for.
    
    Returns:
    this assertion object.
  - doesNotContainSubsequence
```
@SafeVarargs
public final IterableAssert<ELEMENT> doesNotContainSubsequence(ELEMENT... sequence)
```
    Description copied from class: AbstractIterableAssert
    Verifies that the actual group does not contain the given subsequence, a subsequence is defined by an ordered group of values with possibly extra values between them.
    Example:
```
 // an Iterable is used in the example but it would also work with an array
 Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya);

 // assertions will pass
 assertThat(elvesRings).doesNotContainSubsequence(nenya, vilya)
                       .doesNotContainSubsequence(narya, vilya);

 // assertion will fail
 assertThat(elvesRings).doesNotContainSubsequence(vilya, nenya);
 assertThat(elvesRings).doesNotContainSubsequence(vilya, narya);
```
    If you want to specify the subsequence not to find with an Iterable, use doesNotContainSubsequence(Iterable) instead.
    Specified by:
    
    doesNotContainSubsequence in interface ObjectEnumerableAssert<IterableAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    doesNotContainSubsequence in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    sequence - the sequence of objects to look for.
    
    Returns:
    this assertion object.
  - doesNotContain
```
@SafeVarargs
public final IterableAssert<ELEMENT> doesNotContain(ELEMENT... values)
```
    Description copied from interface: ObjectEnumerableAssert
    Verifies that the actual group does not contain the given values.
    Example:
```
 // an Iterable is used in the example but it would also work with an array
 Iterable<String> abc = newArrayList("a", "b", "c");

 // assertions will pass
 assertThat(abc).doesNotContain("d")
                .doesNotContain("d", "e");
 
 // assertions will fail
 assertThat(abc).doesNotContain("a");
 assertThat(abc).doesNotContain("a", "b");
 assertThat(abc).doesNotContain("c", "d");
```
    If you want to specify the elements not to find with an Iterable, use doesNotContainAnyElementsOf(Iterable) instead.
    Specified by:
    
    doesNotContain in interface ObjectEnumerableAssert<IterableAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    doesNotContain in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    values - the given values.
    
    Returns:
    this assertion object.
  - endsWith
```
@SafeVarargs
public final IterableAssert<ELEMENT> endsWith(ELEMENT first,
                                           ELEMENT... rest)
```
    Description copied from class: AbstractIterableAssert
    Verifies that the actual group ends with the given sequence of objects, without any other objects between them. Similar to ObjectEnumerableAssert.containsSequence(Object...), but it also verifies that the last element in the sequence is also last element of the actual group.
    Example:
```
 // an Iterable is used in the example but it would also work with an array
 Iterable<String> abc = newArrayList("a", "b", "c");

 // assertions will pass
 assertThat(abc).endsWith("c")
                .endsWith("b", "c");
 
 // assertions will fail
 assertThat(abc).endsWith("a");
 assertThat(abc).endsWith("a", "b");
```
    Specified by:
    
    endsWith in interface ObjectEnumerableAssert<IterableAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    endsWith in class AbstractIterableAssert<IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    rest - the sequence of objects to look for.
    
    Returns:
    this assertion object.

Class IterableAssert<ELEMENT>

Field Summary

Fields inherited from class org.assertj.core.api.AbstractIterableAssert

Fields inherited from class org.assertj.core.api.AbstractAssert

Constructor Summary

Method Summary

Methods inherited from class org.assertj.core.api.FactoryBasedNavigableIterableAssert

Methods inherited from class org.assertj.core.api.AbstractIterableAssert

Methods inherited from class org.assertj.core.api.AbstractAssert

Methods inherited from class java.lang.Object

Constructor Detail

IterableAssert

IterableAssert

Method Detail

isEqualTo

isInstanceOf

isInstanceOfAny

isOfAnyClassIn

isExactlyInstanceOf

isNotInstanceOf

isNotInstanceOfAny

isNotOfAnyClassIn

isNotExactlyInstanceOf

isSameAs

isNotSameAs

startsWith

contains

containsOnly

containsOnlyOnce

containsExactly

containsExactlyInAnyOrder

isSubsetOf

containsSequence

doesNotContainSequence

containsSubsequence

doesNotContainSubsequence

doesNotContain

endsWith