Top Description Inners Fields Constructors Methods
org.junit.jupiter.api

pack-priv Class AssertLinesMatch

extends Object
Class Inheritance
Static Imports
java.lang.String.join, org.junit.jupiter.api.AssertionFailureBuilder.assertionFailure, org.junit.platform.commons.util.Preconditions.condition, .Preconditions.notNull
AssertLinesMatch is a collection of utility methods that support asserting lines of String equality or java.util.regex.Pattern-match in tests.
Since
5.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static record
AssertLinesMatch.LinesMatcher

Field Summary

Modifier and TypeField and Description
private static final int
MAX_SNIPPET_LENGTH

Constructor Summary

AccessConstructor and Description
private
AssertLinesMatch()

Method Summary

Modifier and TypeMethod and Description
pack-priv static void
assertLinesMatch(List<String> expectedLines, List<String> actualLines)

pack-priv static void
assertLinesMatch(List<String> expectedLines, List<String> actualLines, @Nullable String message)

pack-priv static void
assertLinesMatch(Stream<String> expectedLines, Stream<String> actualLines)

pack-priv static void
assertLinesMatch(Stream<String> expectedLines, Stream<String> actualLines, @Nullable String message)

pack-priv static void
assertLinesMatch(Stream<String> expectedLines, Stream<String> actualLines, @Nullable Object messageOrSupplier)

pack-priv static void
assertLinesMatch(List<String> expectedLines, List<String> actualLines, @Nullable Object messageOrSupplier)

pack-priv static boolean
isFastForwardLine(String line)

pack-priv static boolean
matches(String expectedLine, String actualLine)

pack-priv static int
parseFastForwardLimit(String fastForwardLine)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

MAX_SNIPPET_LENGTHback to summary
private static final int MAX_SNIPPET_LENGTH

Constructor Detail

AssertLinesMatchback to summary
private AssertLinesMatch()

Method Detail

assertLinesMatchback to summary
pack-priv static void assertLinesMatch(List<String> expectedLines, List<String> actualLines)
assertLinesMatchback to summary
pack-priv static void assertLinesMatch(List<String> expectedLines, List<String> actualLines, @Nullable String message)
assertLinesMatchback to summary
pack-priv static void assertLinesMatch(Stream<String> expectedLines, Stream<String> actualLines)
assertLinesMatchback to summary
pack-priv static void assertLinesMatch(Stream<String> expectedLines, Stream<String> actualLines, @Nullable String message)
assertLinesMatchback to summary
pack-priv static void assertLinesMatch(Stream<String> expectedLines, Stream<String> actualLines, @Nullable Object messageOrSupplier)
assertLinesMatchback to summary
pack-priv static void assertLinesMatch(List<String> expectedLines, List<String> actualLines, @Nullable Object messageOrSupplier)
isFastForwardLineback to summary
pack-priv static boolean isFastForwardLine(String line)
matchesback to summary
pack-priv static boolean matches(String expectedLine, String actualLine)
parseFastForwardLimitback to summary
pack-priv static int parseFastForwardLimit(String fastForwardLine)
org.junit.jupiter.api back to summary

private final Record AssertLinesMatch.LinesMatcher

extends Record
Class Inheritance
Record Components
expectedLines:List<String> 
actualLines:List<String> 
messageOrSupplier:@Nullable Object 

Field Summary

Modifier and TypeField and Description
private final List<String>
actualLines

Record Component accessed by actualLines().

private final List<String>
expectedLines

Record Component accessed by expectedLines().

private final @Nullable Object
messageOrSupplier

Record Component accessed by messageOrSupplier().

Constructor Summary

AccessConstructor and Description
private
LinesMatcher(List<String> expectedLines, List<String> actualLines, @Nullable Object messageOrSupplier)

Method Summary

Modifier and TypeMethod and Description
public List<String>
actualLines()

Record Component getter of actualLines.

pack-priv void
assertLinesMatch()

pack-priv void
assertLinesMatchWithFastForward()

public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public List<String>
expectedLines()

Record Component getter of expectedLines.

pack-priv void
fail(String format, Object... args)

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public @Nullable Object
messageOrSupplier()

Record Component getter of messageOrSupplier.

pack-priv String
snippet(String line)

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

actualLinesback to summary
private final List<String> actualLines

Record Component accessed by actualLines().

expectedLinesback to summary
private final List<String> expectedLines

Record Component accessed by expectedLines().

messageOrSupplierback to summary
private final @Nullable Object messageOrSupplier

Record Component accessed by messageOrSupplier().

Constructor Detail

LinesMatcherback to summary
private LinesMatcher(List<String> expectedLines, List<String> actualLines, @Nullable Object messageOrSupplier)

Method Detail

actualLinesback to summary
public List<String> actualLines()

Record Component getter of actualLines.

assertLinesMatchback to summary
pack-priv void assertLinesMatch()
assertLinesMatchWithFastForwardback to summary
pack-priv void assertLinesMatchWithFastForward()
equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: 

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
expectedLinesback to summary
public List<String> expectedLines()

Record Component getter of expectedLines.

failback to summary
pack-priv void fail(String format, Object... args)
hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

messageOrSupplierback to summary
public @Nullable Object messageOrSupplier()

Record Component getter of messageOrSupplier.

snippetback to summary
pack-priv String snippet(String line)
toStringback to summary
public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.