Skip to content

Commit 9a11034

Browse files
committed
[master] Added missing Javadoc
1 parent 94db22b commit 9a11034

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/main/kotlin/in/rcard/assertj/arrowcore/AbstractEitherAssert.kt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,9 @@ abstract class AbstractEitherAssert<
8686
* Verifies that the actual [Either] contains a right-sided value and gives this value to the given
8787
* consumer for further assertions. Should be used as a way of deeper asserting on the
8888
* containing object, as further requirement(s) for the value.
89+
*
90+
* @param requirement the consumer that will accept the right-sided value for deep asserting.
91+
* @return this assertion object.
8992
*/
9093
fun hasRightValueSatisfying(requirement: (RIGHT) -> Unit): SELF {
9194
assertIsRight()
@@ -116,6 +119,13 @@ abstract class AbstractEitherAssert<
116119
return myself
117120
}
118121

122+
/**
123+
* Verifies that the actual left-sided [Either] contains a value that is an
124+
* instance of the argument.
125+
*
126+
* @param expectedClass the expected class of the value inside the left-sided [Either].
127+
* @return this assertion object.
128+
*/
119129
fun containsLeftInstanceOf(expectedClass: Class<*>): SELF {
120130
assertIsLeft()
121131
actual.onLeft { left ->
@@ -130,6 +140,9 @@ abstract class AbstractEitherAssert<
130140
* Verifies that the actual [Either] contains a left-sided value and gives this value to the given
131141
* consumer for further assertions. Should be used as a way of deeper asserting on the
132142
* containing object, as further requirement(s) for the value.
143+
*
144+
* @param requirement the consumer that will accept the left-sided value for deep asserting.
145+
* @return this assertion object.
133146
*/
134147
fun hasLeftValueSatisfying(requirement: (LEFT) -> Unit): SELF {
135148
assertIsLeft()

0 commit comments

Comments
 (0)