Skip to content

Commit

Permalink
update javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
feeblefakie committed May 27, 2020
1 parent 38fa864 commit 8a03212
Show file tree
Hide file tree
Showing 41 changed files with 1,673 additions and 106 deletions.
3 changes: 3 additions & 0 deletions docs/javadoc/allclasses-frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="com/scalar/db/exception/transaction/CommitException.html" title="class in com.scalar.db.exception.transaction" target="classFrame">CommitException</a></li>
<li><a href="com/scalar/db/transaction/consensuscommit/CommitHandler.html" title="class in com.scalar.db.transaction.consensuscommit" target="classFrame">CommitHandler</a></li>
<li><a href="com/scalar/db/transaction/consensuscommit/CommitMutationComposer.html" title="class in com.scalar.db.transaction.consensuscommit" target="classFrame">CommitMutationComposer</a></li>
<li><a href="com/scalar/db/exception/transaction/CommitRuntimeException.html" title="class in com.scalar.db.exception.transaction" target="classFrame">CommitRuntimeException</a></li>
<li><a href="com/scalar/db/api/ConditionalExpression.html" title="class in com.scalar.db.api" target="classFrame">ConditionalExpression</a></li>
<li><a href="com/scalar/db/api/ConditionalExpression.Operator.html" title="enum in com.scalar.db.api" target="classFrame">ConditionalExpression.Operator</a></li>
<li><a href="com/scalar/db/storage/cassandra/ConditionSetter.html" title="class in com.scalar.db.storage.cassandra" target="classFrame">ConditionSetter</a></li>
Expand Down Expand Up @@ -86,6 +87,8 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="com/scalar/db/storage/cassandra/ScannerIterator.html" title="class in com.scalar.db.storage.cassandra" target="classFrame">ScannerIterator</a></li>
<li><a href="com/scalar/db/api/Selection.html" title="class in com.scalar.db.api" target="classFrame">Selection</a></li>
<li><a href="com/scalar/db/storage/cassandra/SelectStatementHandler.html" title="class in com.scalar.db.storage.cassandra" target="classFrame">SelectStatementHandler</a></li>
<li><a href="com/scalar/db/api/SerializableStrategy.html" title="interface in com.scalar.db.api" target="classFrame"><span class="interfaceName">SerializableStrategy</span></a></li>
<li><a href="com/scalar/db/transaction/consensuscommit/SerializableStrategy.html" title="enum in com.scalar.db.transaction.consensuscommit" target="classFrame">SerializableStrategy</a></li>
<li><a href="com/scalar/db/transaction/consensuscommit/Snapshot.html" title="class in com.scalar.db.transaction.consensuscommit" target="classFrame">Snapshot</a></li>
<li><a href="com/scalar/db/storage/cassandra/StatementCache.html" title="class in com.scalar.db.storage.cassandra" target="classFrame">StatementCache</a></li>
<li><a href="com/scalar/db/storage/cassandra/StatementHandler.html" title="class in com.scalar.db.storage.cassandra" target="classFrame">StatementHandler</a></li>
Expand Down
3 changes: 3 additions & 0 deletions docs/javadoc/allclasses-noframe.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="com/scalar/db/exception/transaction/CommitException.html" title="class in com.scalar.db.exception.transaction">CommitException</a></li>
<li><a href="com/scalar/db/transaction/consensuscommit/CommitHandler.html" title="class in com.scalar.db.transaction.consensuscommit">CommitHandler</a></li>
<li><a href="com/scalar/db/transaction/consensuscommit/CommitMutationComposer.html" title="class in com.scalar.db.transaction.consensuscommit">CommitMutationComposer</a></li>
<li><a href="com/scalar/db/exception/transaction/CommitRuntimeException.html" title="class in com.scalar.db.exception.transaction">CommitRuntimeException</a></li>
<li><a href="com/scalar/db/api/ConditionalExpression.html" title="class in com.scalar.db.api">ConditionalExpression</a></li>
<li><a href="com/scalar/db/api/ConditionalExpression.Operator.html" title="enum in com.scalar.db.api">ConditionalExpression.Operator</a></li>
<li><a href="com/scalar/db/storage/cassandra/ConditionSetter.html" title="class in com.scalar.db.storage.cassandra">ConditionSetter</a></li>
Expand Down Expand Up @@ -86,6 +87,8 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="com/scalar/db/storage/cassandra/ScannerIterator.html" title="class in com.scalar.db.storage.cassandra">ScannerIterator</a></li>
<li><a href="com/scalar/db/api/Selection.html" title="class in com.scalar.db.api">Selection</a></li>
<li><a href="com/scalar/db/storage/cassandra/SelectStatementHandler.html" title="class in com.scalar.db.storage.cassandra">SelectStatementHandler</a></li>
<li><a href="com/scalar/db/api/SerializableStrategy.html" title="interface in com.scalar.db.api"><span class="interfaceName">SerializableStrategy</span></a></li>
<li><a href="com/scalar/db/transaction/consensuscommit/SerializableStrategy.html" title="enum in com.scalar.db.transaction.consensuscommit">SerializableStrategy</a></li>
<li><a href="com/scalar/db/transaction/consensuscommit/Snapshot.html" title="class in com.scalar.db.transaction.consensuscommit">Snapshot</a></li>
<li><a href="com/scalar/db/storage/cassandra/StatementCache.html" title="class in com.scalar.db.storage.cassandra">StatementCache</a></li>
<li><a href="com/scalar/db/storage/cassandra/StatementHandler.html" title="class in com.scalar.db.storage.cassandra">StatementHandler</a></li>
Expand Down
23 changes: 20 additions & 3 deletions docs/javadoc/com/scalar/db/api/ConditionalExpression.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -192,13 +192,17 @@ <h3>Method Summary</h3>
<div class="block">Return the value used to compare with the target value</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/scalar/db/api/ConditionalExpression.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -288,7 +292,7 @@ <h4>getOperator</h4>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;o)</pre>
Expand All @@ -309,6 +313,19 @@ <h4>equals</h4>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
Expand Down
25 changes: 21 additions & 4 deletions docs/javadoc/com/scalar/db/api/Delete.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -189,16 +189,20 @@ <h3>Method Summary</h3>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/scalar/db/api/Delete.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/scalar/db/api/Delete.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../com/scalar/db/api/Delete.html" title="class in com.scalar.db.api">Delete</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/scalar/db/api/Delete.html#withCondition-com.scalar.db.api.MutationCondition-">withCondition</a></span>(<a href="../../../../com/scalar/db/api/MutationCondition.html" title="interface in com.scalar.db.api">MutationCondition</a>&nbsp;condition)</code>
<div class="block">Sets the specified <a href="../../../../com/scalar/db/api/MutationCondition.html" title="interface in com.scalar.db.api"><code>MutationCondition</code></a></div>
</td>
</tr>
<tr id="i6" class="altColor">
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/scalar/db/api/Delete.html" title="class in com.scalar.db.api">Delete</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/scalar/db/api/Delete.html#withConsistency-com.scalar.db.api.Consistency-">withConsistency</a></span>(<a href="../../../../com/scalar/db/api/Consistency.html" title="enum in com.scalar.db.api">Consistency</a>&nbsp;consistency)</code>
<div class="block">Sets the specified consistency level for this operation</div>
Expand All @@ -224,7 +228,7 @@ <h3>Methods inherited from class&nbsp;com.scalar.db.api.<a href="../../../../com
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -395,6 +399,19 @@ <h4>equals</h4>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../com/scalar/db/api/Mutation.html#hashCode--">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/scalar/db/api/Mutation.html" title="class in com.scalar.db.api">Mutation</a></code></dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
Expand Down
21 changes: 19 additions & 2 deletions docs/javadoc/com/scalar/db/api/DeleteIf.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -172,13 +172,17 @@ <h3>Method Summary</h3>
<div class="block">Returns the immutable list of conditional expressions.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/scalar/db/api/DeleteIf.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -250,6 +254,19 @@ <h4>accept</h4>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
Expand Down
23 changes: 20 additions & 3 deletions docs/javadoc/com/scalar/db/api/DeleteIfExists.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -170,13 +170,17 @@ <h3>Method Summary</h3>
<div class="block">Returns an empty list of <a href="../../../../com/scalar/db/io/Value.html" title="interface in com.scalar.db.io"><code>Value</code></a>s since any conditions are not given to this object.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/scalar/db/api/DeleteIfExists.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -246,7 +250,7 @@ <h4>accept</h4>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;o)</pre>
Expand All @@ -266,6 +270,19 @@ <h4>equals</h4>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
Expand Down
Loading

0 comments on commit 8a03212

Please sign in to comment.