Skip to content

Commit

Permalink
update memory javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
@leerho
leerho committed Jul 4, 2018
1 parent 4c5db59 commit 83b8661
Show file tree
Hide file tree
Showing 49 changed files with 5,620 additions and 2,740 deletions.
9 changes: 5 additions & 4 deletions api/memory/snapshot/apidocs/allclasses-frame.html
View file
Expand Up @@ -2,22 +2,23 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_121) on Thu Jan 18 17:25:17 PST 2018 -->
<!-- Generated by javadoc (1.8.0_162) on Tue Jul 03 22:21:33 PDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (com.yahoo.datasketches:memory 0.10.5-SNAPSHOT API)</title>
<meta name="date" content="2018-01-18">
<title>All Classes (com.yahoo.datasketches:memory 0.12.1-SNAPSHOT API)</title>
<meta name="date" content="2018-07-03">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="com/yahoo/memory/BaseBuffer.html" title="class in com.yahoo.memory" target="classFrame">BaseBuffer</a></li>
<li><a href="com/yahoo/memory/Buffer.html" title="class in com.yahoo.memory" target="classFrame">Buffer</a></li>
<li><a href="com/yahoo/memory/DefaultMemoryRequestServer.html" title="class in com.yahoo.memory" target="classFrame">DefaultMemoryRequestServer</a></li>
<li><a href="com/yahoo/memory/Handle.html" title="interface in com.yahoo.memory" target="classFrame"><span class="interfaceName">Handle</span></a></li>
<li><a href="com/yahoo/memory/MapHandle.html" title="class in com.yahoo.memory" target="classFrame">MapHandle</a></li>
<li><a href="com/yahoo/memory/Memory.html" title="class in com.yahoo.memory" target="classFrame">Memory</a></li>
<li><a href="com/yahoo/memory/MemoryManager.html" title="interface in com.yahoo.memory" target="classFrame"><span class="interfaceName">MemoryManager</span></a></li>
<li><a href="com/yahoo/memory/MemoryRequestServer.html" title="interface in com.yahoo.memory" target="classFrame"><span class="interfaceName">MemoryRequestServer</span></a></li>
<li><a href="com/yahoo/memory/ReadOnlyException.html" title="class in com.yahoo.memory" target="classFrame">ReadOnlyException</a></li>
<li><a href="com/yahoo/memory/UnsafeUtil.html" title="class in com.yahoo.memory" target="classFrame">UnsafeUtil</a></li>
Expand Down
9 changes: 5 additions & 4 deletions api/memory/snapshot/apidocs/allclasses-noframe.html
View file
Expand Up @@ -2,22 +2,23 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_121) on Thu Jan 18 17:25:17 PST 2018 -->
<!-- Generated by javadoc (1.8.0_162) on Tue Jul 03 22:21:33 PDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (com.yahoo.datasketches:memory 0.10.5-SNAPSHOT API)</title>
<meta name="date" content="2018-01-18">
<title>All Classes (com.yahoo.datasketches:memory 0.12.1-SNAPSHOT API)</title>
<meta name="date" content="2018-07-03">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="com/yahoo/memory/BaseBuffer.html" title="class in com.yahoo.memory">BaseBuffer</a></li>
<li><a href="com/yahoo/memory/Buffer.html" title="class in com.yahoo.memory">Buffer</a></li>
<li><a href="com/yahoo/memory/DefaultMemoryRequestServer.html" title="class in com.yahoo.memory">DefaultMemoryRequestServer</a></li>
<li><a href="com/yahoo/memory/Handle.html" title="interface in com.yahoo.memory"><span class="interfaceName">Handle</span></a></li>
<li><a href="com/yahoo/memory/MapHandle.html" title="class in com.yahoo.memory">MapHandle</a></li>
<li><a href="com/yahoo/memory/Memory.html" title="class in com.yahoo.memory">Memory</a></li>
<li><a href="com/yahoo/memory/MemoryManager.html" title="interface in com.yahoo.memory"><span class="interfaceName">MemoryManager</span></a></li>
<li><a href="com/yahoo/memory/MemoryRequestServer.html" title="interface in com.yahoo.memory"><span class="interfaceName">MemoryRequestServer</span></a></li>
<li><a href="com/yahoo/memory/ReadOnlyException.html" title="class in com.yahoo.memory">ReadOnlyException</a></li>
<li><a href="com/yahoo/memory/UnsafeUtil.html" title="class in com.yahoo.memory">UnsafeUtil</a></li>
Expand Down
1,054 changes: 1,054 additions & 0 deletions api/memory/snapshot/apidocs/com/yahoo/memory/BaseBuffer.html
View file

Large diffs are not rendered by default.

1,026 changes: 547 additions & 479 deletions api/memory/snapshot/apidocs/com/yahoo/memory/Buffer.html
View file

Large diffs are not rendered by default.

366 changes: 366 additions & 0 deletions api/memory/snapshot/apidocs/com/yahoo/memory/DefaultMemoryRequestServer.html
View file

Large diffs are not rendered by default.

46 changes: 36 additions & 10 deletions api/memory/snapshot/apidocs/com/yahoo/memory/Handle.html
View file
Expand Up @@ -2,24 +2,24 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_121) on Thu Jan 18 17:25:16 PST 2018 -->
<!-- Generated by javadoc (1.8.0_162) on Tue Jul 03 22:21:33 PDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Handle (com.yahoo.datasketches:memory 0.10.5-SNAPSHOT API)</title>
<meta name="date" content="2018-01-18">
<title>Handle (com.yahoo.datasketches:memory 0.12.1-SNAPSHOT API)</title>
<meta name="date" content="2018-07-03">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Handle (com.yahoo.datasketches:memory 0.10.5-SNAPSHOT API)";
parent.document.title="Handle (com.yahoo.datasketches:memory 0.12.1-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var methods = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -50,7 +50,7 @@
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/yahoo/memory/Buffer.html" title="class in com.yahoo.memory"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/yahoo/memory/DefaultMemoryRequestServer.html" title="class in com.yahoo.memory"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/yahoo/memory/MapHandle.html" title="class in com.yahoo.memory"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
Expand Down Expand Up @@ -101,12 +101,21 @@ <h2 title="Interface Handle" class="title">Interface Handle</h2>
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../com/yahoo/memory/WritableHandle.html" title="interface in com.yahoo.memory">WritableHandle</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../com/yahoo/memory/MapHandle.html" title="class in com.yahoo.memory">MapHandle</a></dd>
<dd><a href="../../../com/yahoo/memory/MapHandle.html" title="class in com.yahoo.memory">MapHandle</a>, <a href="../../../com/yahoo/memory/WritableDirectHandle.html" title="class in com.yahoo.memory">WritableDirectHandle</a>, <a href="../../../com/yahoo/memory/WritableMapHandle.html" title="class in com.yahoo.memory">WritableMapHandle</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Handle</span></pre>
<pre>public interface <span class="typeNameLabel">Handle</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></pre>
<div class="block">A handle for Memory.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
Expand All @@ -131,6 +140,10 @@ <h3>Method Summary</h3>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/yahoo/memory/Handle.html#close--">close</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../com/yahoo/memory/Memory.html" title="class in com.yahoo.memory">Memory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/yahoo/memory/Handle.html#get--">get</a></span>()</code>
<div class="block">Gets a Memory</div>
Expand All @@ -154,7 +167,7 @@ <h3>Method Detail</h3>
<a name="get--">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre><a href="../../../com/yahoo/memory/Memory.html" title="class in com.yahoo.memory">Memory</a>&nbsp;get()</pre>
Expand All @@ -165,6 +178,19 @@ <h4>get</h4>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
Expand Down Expand Up @@ -193,7 +219,7 @@ <h4>get</h4>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/yahoo/memory/Buffer.html" title="class in com.yahoo.memory"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/yahoo/memory/DefaultMemoryRequestServer.html" title="class in com.yahoo.memory"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/yahoo/memory/MapHandle.html" title="class in com.yahoo.memory"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
Expand Down
22 changes: 16 additions & 6 deletions api/memory/snapshot/apidocs/com/yahoo/memory/MapHandle.html
View file
Expand Up @@ -2,18 +2,18 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_121) on Thu Jan 18 17:25:16 PST 2018 -->
<!-- Generated by javadoc (1.8.0_162) on Tue Jul 03 22:21:33 PDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MapHandle (com.yahoo.datasketches:memory 0.10.5-SNAPSHOT API)</title>
<meta name="date" content="2018-01-18">
<title>MapHandle (com.yahoo.datasketches:memory 0.12.1-SNAPSHOT API)</title>
<meta name="date" content="2018-07-03">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MapHandle (com.yahoo.datasketches:memory 0.10.5-SNAPSHOT API)";
parent.document.title="MapHandle (com.yahoo.datasketches:memory 0.12.1-SNAPSHOT API)";
}
}
catch(err) {
Expand Down Expand Up @@ -110,11 +110,15 @@ <h2 title="Class MapHandle" class="title">Class MapHandle</h2>
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../com/yahoo/memory/Handle.html" title="interface in com.yahoo.memory">Handle</a></dd>
<dd><a href="../../../com/yahoo/memory/Handle.html" title="interface in com.yahoo.memory">Handle</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../com/yahoo/memory/WritableMapHandle.html" title="class in com.yahoo.memory">WritableMapHandle</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">MapHandle</span>
<pre>public class <span class="typeNameLabel">MapHandle</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../com/yahoo/memory/Handle.html" title="interface in com.yahoo.memory">Handle</a></pre>
<div class="block">Gets a Memory for a memory-mapped, read-only file resource, It is highly recommended that this
Expand Down Expand Up @@ -209,6 +213,12 @@ <h4>get</h4>
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/yahoo/memory/Handle.html#close--">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/yahoo/memory/Handle.html" title="interface in com.yahoo.memory">Handle</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
</dl>
</li>
</ul>
<a name="load--">
Expand Down

0 comments on commit 83b8661

Please sign in to comment.