Skip to content

Commit

Permalink
Generate Javadoc and JDiff for Guava HEAD-jre-SNAPSHOT
Browse files Browse the repository at this point in the history
  • Loading branch information
copybara-service[bot] committed Nov 16, 2022
1 parent 642db83 commit bdbcb37
Show file tree
Hide file tree
Showing 350 changed files with 2,938 additions and 31,858 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1378,8 +1378,6 @@ <h4>toString</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string representation of the object.</dd>
</dl>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -546,14 +546,6 @@ <h4>equals</h4>
<dd><code><a href="Function.html#equals(java.lang.Object)">equals</a></code>&nbsp;in interface&nbsp;<code><a href="Function.html" title="interface in com.google.common.base">Function</a>&lt;<a href="Converter.html" title="type parameter in Converter">A</a>,&#8203;<a href="Converter.html" title="type parameter in Converter">B</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - the reference object with which to compare.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this object is the same as the obj
argument; <code>false</code> otherwise.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Object.hashCode()</code>,
<code>HashMap</code></dd>
</dl>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -262,14 +262,6 @@ <h4>equals</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>obj</code> - the reference object with which to compare.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this object is the same as the obj
argument; <code>false</code> otherwise.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Object.hashCode()</code>,
<code>HashMap</code></dd>
</dl>
</li>
</ul>
Expand All @@ -284,11 +276,6 @@ <h4>hashCode</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a hash code value for this object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Object.equals(java.lang.Object)</code>,
<code>System.identityHashCode(java.lang.Object)</code></dd>
</dl>
</li>
</ul>
Expand All @@ -304,8 +291,6 @@ <h4>toString</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string representation of the object.</dd>
</dl>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -246,10 +246,7 @@ <h3>Method Summary</h3>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
<td class="colLast">
<div class="block">Closes this stream and releases any system resources associated
with it.</div>
</td>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
Expand Down Expand Up @@ -302,16 +299,6 @@ <h3>Method Detail</h3>
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../src-html/com/google/common/base/FinalizableReferenceQueue.html#line.177">close</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code>java.io.Closeable</code></span></div>
<div class="block">Closes this stream and releases any system resources associated
with it. If the stream is already closed then invoking this
method has no effect.

<p> As noted in <code>AutoCloseable.close()</code>, cases where the
close may fail require careful attention. It is strongly advised
to relinquish the underlying resources and to internally
<em>mark</em> the <code>Closeable</code> as closed, prior to throwing
the <code>IOException</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -254,14 +254,6 @@ <h4>equals</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - the reference object with which to compare.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this object is the same as the obj
argument; <code>false</code> otherwise.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Object.hashCode()</code>,
<code>HashMap</code></dd>
</dl>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -576,8 +576,6 @@ <h4>toString</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string representation of the object.</dd>
</dl>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -596,14 +596,6 @@ <h4>equals</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - the reference object with which to compare.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this object is the same as the obj
argument; <code>false</code> otherwise.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Object.hashCode()</code>,
<code>HashMap</code></dd>
</dl>
</li>
</ul>
Expand All @@ -621,11 +613,6 @@ <h4>hashCode</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a hash code value for this object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Object.equals(java.lang.Object)</code>,
<code>System.identityHashCode(java.lang.Object)</code></dd>
</dl>
</li>
</ul>
Expand All @@ -643,8 +630,6 @@ <h4>toString</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string representation of the object.</dd>
</dl>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -251,14 +251,6 @@ <h4>equals</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - the reference object with which to compare.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this object is the same as the obj
argument; <code>false</code> otherwise.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Object.hashCode()</code>,
<code>HashMap</code></dd>
</dl>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -815,8 +815,6 @@ <h4>toString</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Enum&lt;<a href="StandardSystemProperty.html" title="enum in com.google.common.base">StandardSystemProperty</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of this enum constant</dd>
</dl>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -459,8 +459,6 @@ <h4>toString</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string representation of the object.</dd>
</dl>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1005,8 +1005,6 @@ <h4>toString</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string representation of the object.</dd>
</dl>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -212,16 +212,12 @@ <h3>Method Summary</h3>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(java.lang.Object&nbsp;obj)</code></th>
<td class="colLast">
<div class="block">Indicates whether some other object is "equal to" this one.</div>
</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a hash code value for the object.</div>
</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="CacheBuilderSpec.html" title="class in com.google.common.cache">CacheBuilderSpec</a></code></td>
Expand Down Expand Up @@ -316,8 +312,6 @@ <h4>toString</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string representation of the object.</dd>
</dl>
</li>
</ul>
Expand All @@ -328,43 +322,9 @@ <h4>toString</h4>
<li class="blockList">
<h4>hashCode</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;<a href="../../../../src-html/com/google/common/cache/CacheBuilderSpec.html#line.238">hashCode</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>java.lang.Object</code></span></div>
<div class="block">Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
<code>HashMap</code>.
<p>
The general contract of <code>hashCode</code> is:
<ul>
<li>Whenever it is invoked on the same object more than once during
an execution of a Java application, the <code>hashCode</code> method
must consistently return the same integer, provided no information
used in <code>equals</code> comparisons on the object is modified.
This integer need not remain consistent from one execution of an
application to another execution of the same application.
<li>If two objects are equal according to the <code>equals(Object)</code>
method, then calling the <code>hashCode</code> method on each of
the two objects must produce the same integer result.
<li>It is <em>not</em> required that if two objects are unequal
according to the <code>Object.equals(java.lang.Object)</code>
method, then calling the <code>hashCode</code> method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hash tables.
</ul>
<p>
As much as is reasonably practical, the hashCode method defined
by class <code>Object</code> does return distinct integers for
distinct objects. (The hashCode may or may not be implemented
as some function of an object's memory address at some point
in time.)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a hash code value for this object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Object.equals(java.lang.Object)</code>,
<code>System.identityHashCode(java.lang.Object)</code></dd>
</dl>
</li>
</ul>
Expand All @@ -376,56 +336,9 @@ <h4>hashCode</h4>
<h4>equals</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;<a href="../../../../src-html/com/google/common/cache/CacheBuilderSpec.html#line.253">equals</a>&#8203;(<a href="https://checkerframework.org/api/javax/annotation/CheckForNull.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@CheckForNull</a>
java.lang.Object&nbsp;obj)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>java.lang.Object</code></span></div>
<div class="block">Indicates whether some other object is "equal to" this one.
<p>
The <code>equals</code> method implements an equivalence relation
on non-null object references:
<ul>
<li>It is <i>reflexive</i>: for any non-null reference value
<code>x</code>, <code>x.equals(x)</code> should return
<code>true</code>.
<li>It is <i>symmetric</i>: for any non-null reference values
<code>x</code> and <code>y</code>, <code>x.equals(y)</code>
should return <code>true</code> if and only if
<code>y.equals(x)</code> returns <code>true</code>.
<li>It is <i>transitive</i>: for any non-null reference values
<code>x</code>, <code>y</code>, and <code>z</code>, if
<code>x.equals(y)</code> returns <code>true</code> and
<code>y.equals(z)</code> returns <code>true</code>, then
<code>x.equals(z)</code> should return <code>true</code>.
<li>It is <i>consistent</i>: for any non-null reference values
<code>x</code> and <code>y</code>, multiple invocations of
<code>x.equals(y)</code> consistently return <code>true</code>
or consistently return <code>false</code>, provided no
information used in <code>equals</code> comparisons on the
objects is modified.
<li>For any non-null reference value <code>x</code>,
<code>x.equals(null)</code> should return <code>false</code>.
</ul>
<p>
The <code>equals</code> method for class <code>Object</code> implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values <code>x</code> and
<code>y</code>, this method returns <code>true</code> if and only
if <code>x</code> and <code>y</code> refer to the same object
(<code>x == y</code> has the value <code>true</code>).
<p>
Note that it is generally necessary to override the <code>hashCode</code>
method whenever this method is overridden, so as to maintain the
general contract for the <code>hashCode</code> method, which states
that equal objects must have equal hash codes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>obj</code> - the reference object with which to compare.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this object is the same as the obj
argument; <code>false</code> otherwise.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Object.hashCode()</code>,
<code>HashMap</code></dd>
</dl>
</li>
</ul>
Expand Down
Loading

0 comments on commit bdbcb37

Please sign in to comment.