ListAssert (AssertJ fluent assertions 2.8.0 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.AbstractListAssert<SELF,ACTUAL,ELEMENT,ELEMENT_ASSERT>
    - - org.assertj.core.api.FactoryBasedNavigableListAssert<ListAssert<ELEMENT>,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
      - org.assertj.core.api.ListAssert<ELEMENT>

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

All Implemented Interfaces:

Assert<ListAssert<ELEMENT>,List<? extends ELEMENT>>, Descriptable<ListAssert<ELEMENT>>, EnumerableAssert<ListAssert<ELEMENT>,ELEMENT>, ExtensionPoints<ListAssert<ELEMENT>,List<? extends ELEMENT>>, IndexedObjectEnumerableAssert<ListAssert<ELEMENT>,ELEMENT>, ObjectEnumerableAssert<ListAssert<ELEMENT>,ELEMENT>
```
public class ListAssert<ELEMENT>
extends FactoryBasedNavigableListAssert<ListAssert<ELEMENT>,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
```
Assertion methods for Lists.
To create an instance of this class, invoke Assertions.assertThat(List).

Author:

Yvonne Wang, Alex Ruiz, Joel Costigliola, Mikhail Mazursky

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

ListAssert(List<? extends ELEMENT> actual)

Constructors
Constructor and Description
`ListAssert(List<? extends ELEMENT> actual)`

Method Summary

Methods
Modifier and Type	Method and Description
`ListAssert<ELEMENT>`	`contains(ELEMENT... values)` Verifies that the actual group contains the given values, in any order.
`ListAssert<ELEMENT>`	`containsExactly(ELEMENT... values)` Verifies that the actual group contains only the given values and nothing else, in order. This assertion should only be used with groups that have a consistent iteration order (i.e.
`ListAssert<ELEMENT>`	`containsExactlyInAnyOrder(ELEMENT... values)` Verifies that the actual group contains exactly the given values and nothing else, in any order.
`ListAssert<ELEMENT>`	`containsOnly(ELEMENT... values)` Verifies that the actual group contains only the given values and nothing else, in any order.
`ListAssert<ELEMENT>`	`containsOnlyOnce(ELEMENT... values)` Verifies that the actual group contains the given values only once.
`ListAssert<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.
`ListAssert<ELEMENT>`	`containsSubsequence(ELEMENT... sequence)` Verifies that the actual group contains the given subsequence in the correct order (possibly with other values between them).
`ListAssert<ELEMENT>`	`doesNotContain(ELEMENT... values)` Verifies that the actual group does not contain the given values.
`ListAssert<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.
`ListAssert<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.
`ListAssert<ELEMENT>`	`endsWith(ELEMENT... sequence)` Verifies that the actual group ends with the given sequence of objects, without any other objects between them.
`ListAssert<ELEMENT>`	`isSubsetOf(ELEMENT... values)` Verifies that all the elements of actual are present in the given values.
`ListAssert<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.FactoryBasedNavigableListAssert
toAssert

Methods inherited from class org.assertj.core.api.AbstractIterableAssert
are, areAtLeast, areAtLeastOne, areAtMost, areExactly, areNot, containsAll, containsExactlyElementsOf, containsNull, containsOnlyElementsOf, containsSequence, containsSubsequence, doesNotContainAnyElementsOf, doesNotContainNull, doesNotContainSequence, doesNotContainSubsequence, doesNotHaveDuplicates, doNotHave, element, extracting, extracting, extracting, extracting, extractingResultOf, extractingResultOf, filteredOn, filteredOn, filteredOn, filteredOnNull, first, flatExtracting, flatExtracting, flatExtracting, hasAtLeastOneElementOfType, hasOnlyElementsOfType, hasOnlyElementsOfTypes, hasSameElementsAs, hasSameSizeAs, hasSameSizeAs, hasSize, have, haveAtLeast, haveAtLeastOne, haveAtMost, haveExactly, inBinary, inHexadecimal, isEmpty, isNotEmpty, isNullOrEmpty, isSubsetOf, last, navigationDescription, newListAssertInstance, size, toLazyIterable, usingComparatorForElementFieldsWithNames, usingComparatorForElementFieldsWithType, usingElementComparatorIgnoringFields, usingElementComparatorOnFields, usingFieldByFieldElementComparator, usingRecursiveFieldByFieldElementComparator

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

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

Methods inherited from interface org.assertj.core.api.EnumerableAssert
hasSameSizeAs, hasSameSizeAs, hasSize, isEmpty, isNotEmpty, isNullOrEmpty

- Constructor Detail
  - ListAssert
```
public ListAssert(List<? extends ELEMENT> actual)
```
- Method Detail
  - contains
```
@SafeVarargs
public final ListAssert<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");
```
    Specified by:
    
    contains in interface ObjectEnumerableAssert<ListAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    contains in class AbstractIterableAssert<ListAssert<ELEMENT>,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    values - the given values.
    
    Returns:
    this assertion object.
  - containsOnly
```
@SafeVarargs
public final ListAssert<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.
    Example :
```
 Iterable<String> abc = newArrayList("a", "b", "c");

 // assertion will pass
 assertThat(abc).containsOnly("c", "b", "a");
 
 // assertion will fail because "c" is missing
 assertThat(abc).containsOnly("a", "b");
```
    Specified by:
    
    containsOnly in interface ObjectEnumerableAssert<ListAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    containsOnly in class AbstractIterableAssert<ListAssert<ELEMENT>,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    values - the given values.
    
    Returns:
    this assertion object.
  - containsOnlyOnce
```
@SafeVarargs
public final ListAssert<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<ListAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    containsOnlyOnce in class AbstractIterableAssert<ListAssert<ELEMENT>,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    values - the given values.
    
    Returns:
    this assertion object.
  - containsExactly
```
@SafeVarargs
public final ListAssert<ELEMENT> containsExactly(ELEMENT... values)
```
    Description copied from class: AbstractIterableAssert
    Verifies that the actual group contains only 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);
```
    Specified by:
    
    containsExactly in interface ObjectEnumerableAssert<ListAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    containsExactly in class AbstractIterableAssert<ListAssert<ELEMENT>,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    values - the given values.
    
    Returns:
    this assertion object.
  - containsExactlyInAnyOrder
```
@SafeVarargs
public final ListAssert<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);
```
    Specified by:
    
    containsExactlyInAnyOrder in interface ObjectEnumerableAssert<ListAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    containsExactlyInAnyOrder in class AbstractIterableAssert<ListAssert<ELEMENT>,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    values - the given values.
    
    Returns:
    this assertion object.
  - isSubsetOf
```
@SafeVarargs
public final ListAssert<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);
```
    Specified by:
    
    isSubsetOf in interface ObjectEnumerableAssert<ListAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    isSubsetOf in class AbstractIterableAssert<ListAssert<ELEMENT>,List<? 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 ListAssert<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);
```
    Specified by:
    
    containsSequence in interface ObjectEnumerableAssert<ListAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    containsSequence in class AbstractIterableAssert<ListAssert<ELEMENT>,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    sequence - the sequence of objects to look for.
    
    Returns:
    this assertion object.
  - doesNotContainSequence
```
@SafeVarargs
public final ListAssert<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);
```
    Specified by:
    
    doesNotContainSequence in interface ObjectEnumerableAssert<ListAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    doesNotContainSequence in class AbstractIterableAssert<ListAssert<ELEMENT>,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    sequence - the sequence of objects to look for.
    
    Returns:
    this assertion object.
  - containsSubsequence
```
@SafeVarargs
public final ListAssert<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);
```
    Specified by:
    
    containsSubsequence in interface ObjectEnumerableAssert<ListAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    containsSubsequence in class AbstractIterableAssert<ListAssert<ELEMENT>,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    sequence - the sequence of objects to look for.
    
    Returns:
    this assertion object.
  - doesNotContainSubsequence
```
@SafeVarargs
public final ListAssert<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);
```
    Specified by:
    
    doesNotContainSubsequence in interface ObjectEnumerableAssert<ListAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    doesNotContainSubsequence in class AbstractIterableAssert<ListAssert<ELEMENT>,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    sequence - the sequence of objects to look for.
    
    Returns:
    this assertion object.
  - doesNotContain
```
@SafeVarargs
public final ListAssert<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");
```
    Specified by:
    
    doesNotContain in interface ObjectEnumerableAssert<ListAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    doesNotContain in class AbstractIterableAssert<ListAssert<ELEMENT>,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    values - the given values.
    
    Returns:
    this assertion object.
  - startsWith
```
@SafeVarargs
public final ListAssert<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<ListAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    startsWith in class AbstractIterableAssert<ListAssert<ELEMENT>,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    sequence - the sequence of objects to look for.
    
    Returns:
    this assertion object.
  - endsWith
```
@SafeVarargs
public final ListAssert<ELEMENT> endsWith(ELEMENT... sequence)
```
    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<ListAssert<ELEMENT>,ELEMENT>
    
    Overrides:
    
    endsWith in class AbstractIterableAssert<ListAssert<ELEMENT>,List<? extends ELEMENT>,ELEMENT,ObjectAssert<ELEMENT>>
    
    Parameters:
    sequence - the sequence of objects to look for.
    
    Returns:
    this assertion object.

Class ListAssert<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.FactoryBasedNavigableListAssert

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

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

Methods inherited from interface org.assertj.core.api.ObjectEnumerableAssert

Methods inherited from interface org.assertj.core.api.EnumerableAssert

Constructor Detail

ListAssert

Method Detail

contains

containsOnly

containsOnlyOnce

containsExactly

containsExactlyInAnyOrder

isSubsetOf

containsSequence

doesNotContainSequence

containsSubsequence

doesNotContainSubsequence

doesNotContain

startsWith

endsWith