Skip to content

Commit

Permalink
Latest javadoc on successful CI build auto-pushed to gh-pages.
Browse files Browse the repository at this point in the history
  • Loading branch information
copybara-service[bot] committed Jun 27, 2024
1 parent 7db6ab9 commit b7276f5
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 42 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -205,24 +205,21 @@ <h3>Method Summary</h3>
<a href="IterableSubject.UsingCorrespondence.html" title="type parameter in IterableSubject.UsingCorrespondence">E</a>&nbsp;second,
<a href="IterableSubject.UsingCorrespondence.html" title="type parameter in IterableSubject.UsingCorrespondence">E</a> @Nullable ...&nbsp;rest)</code></th>
<td class="colLast">
<div class="block">Checks that the subject contains elements that corresponds to all of the expected elements,
i.e.</div>
<div class="block">Checks that the subject contains elements that correspond to all the expected elements, i.e.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="Ordered.html" title="interface in com.google.common.truth">Ordered</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsAtLeastElementsIn(E%5B%5D)">containsAtLeastElementsIn</a></span>&#8203;(<a href="IterableSubject.UsingCorrespondence.html" title="type parameter in IterableSubject.UsingCorrespondence">E</a>[]&nbsp;expected)</code></th>
<td class="colLast">
<div class="block">Checks that the subject contains elements that corresponds to all of the expected elements,
i.e.</div>
<div class="block">Checks that the subject contains elements that correspond to all the expected elements, i.e.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="Ordered.html" title="interface in com.google.common.truth">Ordered</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsAtLeastElementsIn(java.lang.Iterable)">containsAtLeastElementsIn</a></span>&#8203;(java.lang.Iterable&lt;? extends <a href="IterableSubject.UsingCorrespondence.html" title="type parameter in IterableSubject.UsingCorrespondence">E</a>&gt;&nbsp;expected)</code></th>
<td class="colLast">
<div class="block">Checks that the subject contains elements that corresponds to all of the expected elements,
i.e.</div>
<div class="block">Checks that the subject contains elements that correspond to all the expected elements, i.e.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
Expand Down Expand Up @@ -429,7 +426,7 @@ <h4>displayingDiffsPairedBy</h4>

<p>On assertions where it makes sense to do so, the elements are paired as follows: they are
keyed by <code>keyFunction</code>, and if an unexpected element and a missing element have the
same non-null key then the they are paired up. (Elements with null keys are not paired.) The
same non-null key then they are paired up. (Elements with null keys are not paired.) The
failure message will show paired elements together, and a diff will be shown if the <a href="Correspondence.html#formatDiff(A,E)"><code>Correspondence.formatDiff(A, E)</code></a> method returns non-null.

<p>The expected elements given in the assertion should be uniquely keyed by <code>
Expand Down Expand Up @@ -472,8 +469,8 @@ <h4>displayingDiffsPairedBy</h4>
<p>On assertions where it makes sense to do so, the elements are paired as follows: the
unexpected elements are keyed by <code>actualKeyFunction</code>, the missing elements are keyed by
<code>expectedKeyFunction</code>, and if an unexpected element and a missing element have the same
non-null key then the they are paired up. (Elements with null keys are not paired.) The
failure message will show paired elements together, and a diff will be shown if the <a href="Correspondence.html#formatDiff(A,E)"><code>Correspondence.formatDiff(A, E)</code></a> method returns non-null.
non-null key then they are paired up. (Elements with null keys are not paired.) The failure
message will show paired elements together, and a diff will be shown if the <a href="Correspondence.html#formatDiff(A,E)"><code>Correspondence.formatDiff(A, E)</code></a> method returns non-null.

<p>The expected elements given in the assertion should be uniquely keyed by <code>
expectedKeyFunction</code>. If multiple missing elements have the same key then the pairing will be
Expand Down Expand Up @@ -589,8 +586,8 @@ <h4>containsAtLeast</h4>
public final&nbsp;<a href="Ordered.html" title="interface in com.google.common.truth">Ordered</a>&nbsp;containsAtLeast&#8203;(<a href="IterableSubject.UsingCorrespondence.html" title="type parameter in IterableSubject.UsingCorrespondence">E</a>&nbsp;first,
<a href="IterableSubject.UsingCorrespondence.html" title="type parameter in IterableSubject.UsingCorrespondence">E</a>&nbsp;second,
<a href="IterableSubject.UsingCorrespondence.html" title="type parameter in IterableSubject.UsingCorrespondence">E</a> @Nullable ...&nbsp;rest)</pre>
<div class="block">Checks that the subject contains elements that corresponds to all of the expected elements,
i.e. that there is a 1:1 mapping between any subset of the actual elements and the expected
<div class="block">Checks that the subject contains elements that correspond to all the expected elements, i.e.
that there is a 1:1 mapping between any subset of the actual elements and the expected
elements where each pair of elements correspond.

<p>To also test that the contents appear in the given order, make a call to <code>inOrder()</code>
Expand All @@ -606,8 +603,8 @@ <h4>containsAtLeast</h4>
<h4>containsAtLeastElementsIn</h4>
<pre class="methodSignature">@CanIgnoreReturnValue
public&nbsp;<a href="Ordered.html" title="interface in com.google.common.truth">Ordered</a>&nbsp;containsAtLeastElementsIn&#8203;(java.lang.Iterable&lt;? extends <a href="IterableSubject.UsingCorrespondence.html" title="type parameter in IterableSubject.UsingCorrespondence">E</a>&gt;&nbsp;expected)</pre>
<div class="block">Checks that the subject contains elements that corresponds to all of the expected elements,
i.e. that there is a 1:1 mapping between any subset of the actual elements and the expected
<div class="block">Checks that the subject contains elements that correspond to all the expected elements, i.e.
that there is a 1:1 mapping between any subset of the actual elements and the expected
elements where each pair of elements correspond.

<p>To also test that the contents appear in the given order, make a call to <code>inOrder()</code>
Expand All @@ -625,8 +622,8 @@ <h4>containsAtLeastElementsIn</h4>
<h4>containsAtLeastElementsIn</h4>
<pre class="methodSignature">@CanIgnoreReturnValue
public&nbsp;<a href="Ordered.html" title="interface in com.google.common.truth">Ordered</a>&nbsp;containsAtLeastElementsIn&#8203;(<a href="IterableSubject.UsingCorrespondence.html" title="type parameter in IterableSubject.UsingCorrespondence">E</a>[]&nbsp;expected)</pre>
<div class="block">Checks that the subject contains elements that corresponds to all of the expected elements,
i.e. that there is a 1:1 mapping between any subset of the actual elements and the expected
<div class="block">Checks that the subject contains elements that correspond to all the expected elements, i.e.
that there is a 1:1 mapping between any subset of the actual elements and the expected
elements where each pair of elements correspond.

<p>To also test that the contents appear in the given order, make a call to <code>inOrder()</code>
Expand Down
16 changes: 8 additions & 8 deletions api/latest/com/google/common/truth/IterableSubject.html
Original file line number Diff line number Diff line change
Expand Up @@ -292,21 +292,21 @@ <h3>Method Summary</h3>
@Nullable java.lang.Object&nbsp;secondExpected,
@Nullable java.lang.Object @Nullable ...&nbsp;restOfExpected)</code></th>
<td class="colLast">
<div class="block">Checks that the actual iterable contains at least all of the expected elements or fails.</div>
<div class="block">Checks that the actual iterable contains at least all the expected elements or fails.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="Ordered.html" title="interface in com.google.common.truth">Ordered</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsAtLeastElementsIn(java.lang.Object%5B%5D)">containsAtLeastElementsIn</a></span>&#8203;(@Nullable java.lang.Object[]&nbsp;expected)</code></th>
<td class="colLast">
<div class="block">Checks that the actual iterable contains at least all of the expected elements or fails.</div>
<div class="block">Checks that the actual iterable contains at least all the expected elements or fails.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="Ordered.html" title="interface in com.google.common.truth">Ordered</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsAtLeastElementsIn(java.lang.Iterable)">containsAtLeastElementsIn</a></span>&#8203;(java.lang.Iterable&lt;?&gt;&nbsp;expectedIterable)</code></th>
<td class="colLast">
<div class="block">Checks that the actual iterable contains at least all of the expected elements or fails.</div>
<div class="block">Checks that the actual iterable contains at least all the expected elements or fails.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
Expand Down Expand Up @@ -359,7 +359,7 @@ <h3>Method Summary</h3>
@Nullable java.lang.Object&nbsp;secondExcluded,
@Nullable java.lang.Object @Nullable ...&nbsp;restOfExcluded)</code></th>
<td class="colLast">
<div class="block">Checks that a actual iterable contains none of the excluded objects or fails.</div>
<div class="block">Checks that an actual iterable contains none of the excluded objects or fails.</div>
</td>
</tr>
<tr id="i16" class="altColor">
Expand Down Expand Up @@ -667,7 +667,7 @@ <h4>containsAtLeast</h4>
public final&nbsp;<a href="Ordered.html" title="interface in com.google.common.truth">Ordered</a>&nbsp;containsAtLeast&#8203;(@Nullable java.lang.Object&nbsp;firstExpected,
@Nullable java.lang.Object&nbsp;secondExpected,
@Nullable java.lang.Object @Nullable ...&nbsp;restOfExpected)</pre>
<div class="block">Checks that the actual iterable contains at least all of the expected elements or fails. If an
<div class="block">Checks that the actual iterable contains at least all the expected elements or fails. If an
element appears more than once in the expected elements to this call then it must appear at
least that number of times in the actual elements.

Expand All @@ -684,7 +684,7 @@ <h4>containsAtLeast</h4>
<h4>containsAtLeastElementsIn</h4>
<pre class="methodSignature">@CanIgnoreReturnValue
public final&nbsp;<a href="Ordered.html" title="interface in com.google.common.truth">Ordered</a>&nbsp;containsAtLeastElementsIn&#8203;(java.lang.Iterable&lt;?&gt;&nbsp;expectedIterable)</pre>
<div class="block">Checks that the actual iterable contains at least all of the expected elements or fails. If an
<div class="block">Checks that the actual iterable contains at least all the expected elements or fails. If an
element appears more than once in the expected elements then it must appear at least that
number of times in the actual elements.

Expand All @@ -701,7 +701,7 @@ <h4>containsAtLeastElementsIn</h4>
<h4>containsAtLeastElementsIn</h4>
<pre class="methodSignature">@CanIgnoreReturnValue
public final&nbsp;<a href="Ordered.html" title="interface in com.google.common.truth">Ordered</a>&nbsp;containsAtLeastElementsIn&#8203;(@Nullable java.lang.Object[]&nbsp;expected)</pre>
<div class="block">Checks that the actual iterable contains at least all of the expected elements or fails. If an
<div class="block">Checks that the actual iterable contains at least all the expected elements or fails. If an
element appears more than once in the expected elements then it must appear at least that
number of times in the actual elements.

Expand Down Expand Up @@ -774,7 +774,7 @@ <h4>containsNoneOf</h4>
<pre class="methodSignature">public final&nbsp;void&nbsp;containsNoneOf&#8203;(@Nullable java.lang.Object&nbsp;firstExcluded,
@Nullable java.lang.Object&nbsp;secondExcluded,
@Nullable java.lang.Object @Nullable ...&nbsp;restOfExcluded)</pre>
<div class="block">Checks that a actual iterable contains none of the excluded objects or fails. (Duplicates are
<div class="block">Checks that an actual iterable contains none of the excluded objects or fails. (Duplicates are
irrelevant to this test, which fails if any of the actual elements equal any of the excluded.)</div>
</li>
</ul>
Expand Down
15 changes: 6 additions & 9 deletions api/latest/com/google/common/truth/class-use/Ordered.html
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ <h3>Uses of <a href="../Ordered.html" title="interface in com.google.common.trut
@Nullable java.lang.Object&nbsp;secondExpected,
@Nullable java.lang.Object @Nullable ...&nbsp;restOfExpected)</code></th>
<td class="colLast">
<div class="block">Checks that the actual iterable contains at least all of the expected elements or fails.</div>
<div class="block">Checks that the actual iterable contains at least all the expected elements or fails.</div>
</td>
</tr>
<tr class="altColor">
Expand All @@ -162,8 +162,7 @@ <h3>Uses of <a href="../Ordered.html" title="interface in com.google.common.trut
<a href="../IterableSubject.UsingCorrespondence.html" title="type parameter in IterableSubject.UsingCorrespondence">E</a>&nbsp;second,
<a href="../IterableSubject.UsingCorrespondence.html" title="type parameter in IterableSubject.UsingCorrespondence">E</a> @Nullable ...&nbsp;rest)</code></th>
<td class="colLast">
<div class="block">Checks that the subject contains elements that corresponds to all of the expected elements,
i.e.</div>
<div class="block">Checks that the subject contains elements that correspond to all the expected elements, i.e.</div>
</td>
</tr>
<tr class="rowColor">
Expand Down Expand Up @@ -244,30 +243,28 @@ <h3>Uses of <a href="../Ordered.html" title="interface in com.google.common.trut
<td class="colFirst"><code><a href="../Ordered.html" title="interface in com.google.common.truth">Ordered</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">IterableSubject.</span><code><span class="memberNameLink"><a href="../IterableSubject.html#containsAtLeastElementsIn(java.lang.Object%5B%5D)">containsAtLeastElementsIn</a></span>&#8203;(@Nullable java.lang.Object[]&nbsp;expected)</code></th>
<td class="colLast">
<div class="block">Checks that the actual iterable contains at least all of the expected elements or fails.</div>
<div class="block">Checks that the actual iterable contains at least all the expected elements or fails.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../Ordered.html" title="interface in com.google.common.truth">Ordered</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">IterableSubject.</span><code><span class="memberNameLink"><a href="../IterableSubject.html#containsAtLeastElementsIn(java.lang.Iterable)">containsAtLeastElementsIn</a></span>&#8203;(java.lang.Iterable&lt;?&gt;&nbsp;expectedIterable)</code></th>
<td class="colLast">
<div class="block">Checks that the actual iterable contains at least all of the expected elements or fails.</div>
<div class="block">Checks that the actual iterable contains at least all the expected elements or fails.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../Ordered.html" title="interface in com.google.common.truth">Ordered</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">IterableSubject.UsingCorrespondence.</span><code><span class="memberNameLink"><a href="../IterableSubject.UsingCorrespondence.html#containsAtLeastElementsIn(E%5B%5D)">containsAtLeastElementsIn</a></span>&#8203;(<a href="../IterableSubject.UsingCorrespondence.html" title="type parameter in IterableSubject.UsingCorrespondence">E</a>[]&nbsp;expected)</code></th>
<td class="colLast">
<div class="block">Checks that the subject contains elements that corresponds to all of the expected elements,
i.e.</div>
<div class="block">Checks that the subject contains elements that correspond to all the expected elements, i.e.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../Ordered.html" title="interface in com.google.common.truth">Ordered</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">IterableSubject.UsingCorrespondence.</span><code><span class="memberNameLink"><a href="../IterableSubject.UsingCorrespondence.html#containsAtLeastElementsIn(java.lang.Iterable)">containsAtLeastElementsIn</a></span>&#8203;(java.lang.Iterable&lt;? extends <a href="../IterableSubject.UsingCorrespondence.html" title="type parameter in IterableSubject.UsingCorrespondence">E</a>&gt;&nbsp;expected)</code></th>
<td class="colLast">
<div class="block">Checks that the subject contains elements that corresponds to all of the expected elements,
i.e.</div>
<div class="block">Checks that the subject contains elements that correspond to all the expected elements, i.e.</div>
</td>
</tr>
<tr class="altColor">
Expand Down
Loading

0 comments on commit b7276f5

Please sign in to comment.