greg/mentat
1
0
Fork 0
Code Issues 294 Pull requests Projects Releases 9 Packages Wiki Activity
mentat/docs/apis/0.7/java/org/mozilla/mentat/InProgressBuilder.html
Emily Toop da599c3a78 Fix broken documentation links. (#775) (#767) r=nalexander 
* Fix broken API doc links

Create symlink for latest to point to v0.7.
Group APIs by top version number rather than individual

* Update swift and android version numbers to match Mentats

* Update documentation

* Update top level .gitignore to ignore docs site & metatdata

* Add README to help with building documentation site

* Address review comments @ncalexan
2018-06-29 10:28:44 -07:00

838 lines
44 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_152-release) on Thu Jun 28 11:01:15 BST 2018 -->
<title>InProgressBuilder</title>
<meta name="date" content="2018-06-28">
<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="InProgressBuilder";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../org/mozilla/mentat/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/mozilla/mentat/InProgress.html" title="class in org.mozilla.mentat"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/mozilla/mentat/InProgressTransactionResult.html" title="class in org.mozilla.mentat"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/mozilla/mentat/InProgressBuilder.html" target="_top">Frames</a></li>
<li><a href="InProgressBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.mozilla.mentat</div>
<h2 title="Class InProgressBuilder" class="title">Class InProgressBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.mozilla.mentat.InProgressBuilder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://developer.android.com/reference/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">InProgressBuilder</span>
extends <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">This class wraps a raw pointer that points to a Rust `InProgressBuilder` object.
<a href="../../../org/mozilla/mentat/InProgressBuilder.html" title="class in org.mozilla.mentat"><code>InProgressBuilder</code></a> provides a programmatic interface to performing assertions for entities.
It provides functions for adding and retracting values for attributes for an entity within
an in progress transaction.
<p/>
The `transact` function will transact the assertions that have been added to the <a href="../../../org/mozilla/mentat/InProgressBuilder.html" title="class in org.mozilla.mentat"><code>InProgressBuilder</code></a>
and pass back the <a href="../../../org/mozilla/mentat/TxReport.html" title="class in org.mozilla.mentat"><code>TxReport</code></a> that was generated by this transact and the <a href="../../../org/mozilla/mentat/InProgress.html" title="class in org.mozilla.mentat"><code>InProgress</code></a> that was
used to perform the transact. This enables you to perform further transacts on the same <a href="../../../org/mozilla/mentat/InProgress.html" title="class in org.mozilla.mentat"><code>InProgress</code></a>
before committing.
<p/>
<pre><code>
long aEntid = txReport.getEntidForTempId("a");
long bEntid = txReport.getEntidForTempId("b");
InProgressBuilder builder = mentat.getEntityBuilder();
builder.add(aEntid, ":foo/boolean", true);
builder.add(bEntid, ":foo/instant", newDate);
InProgress inProgress = builder.transact().getInProgress();
inProgress.transact("[[:db/add \(aEntid) :foo/long 22]]");
inProgress.commit();
</code></pre>
<p/>
The `commit` function will transact and commit the assertions that have been added to the
<a href="../../../org/mozilla/mentat/InProgressBuilder.html" title="class in org.mozilla.mentat"><code>InProgressBuilder</code></a>.
It will consume the <a href="../../../org/mozilla/mentat/InProgress.html" title="class in org.mozilla.mentat"><code>InProgress</code></a> used to perform the transact. It returns the <a href="../../../org/mozilla/mentat/TxReport.html" title="class in org.mozilla.mentat"><code>TxReport</code></a>
generated by the transact. After calling `commit`, a new transaction must be started by calling
<pre>Mentat.beginTransaction()</pre> in order to perform further actions.
<p/>
<pre><code>
long aEntid = txReport.getEntidForTempId("a");
long bEntid = txReport.getEntidForTempId("b");
InProgressBuilder builder = mentat.getEntityBuilder();
builder.add(aEntid, ":foo/boolean", true);
builder.add(bEntid, ":foo/instant", newDate);
builder.commit();
</code></pre></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#InProgressBuilder-org.mozilla.mentat.JNA.InProgressBuilder-">InProgressBuilder</a></span>(<a href="../../../org/mozilla/mentat/JNA.InProgressBuilder.html" title="class in org.mozilla.mentat">JNA.InProgressBuilder</a>&nbsp;pointer)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<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="../../../org/mozilla/mentat/InProgressBuilder.html#add-long-java.lang.String-boolean-">add</a></span>(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
boolean&nbsp;value)</code>
<div class="block">Asserts the value of attribute `keyword` to be the provided `value`.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#add-long-java.lang.String-java.util.Date-">add</a></span>(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
<a href="https://developer.android.com/reference/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;value)</code>
<div class="block">Asserts the value of attribute `keyword` to be the provided `value`.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#add-long-java.lang.String-double-">add</a></span>(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
double&nbsp;value)</code>
<div class="block">Asserts the value of attribute `keyword` to be the provided `value`.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#add-long-java.lang.String-long-">add</a></span>(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
long&nbsp;value)</code>
<div class="block">Asserts the value of attribute `keyword` to be the provided `value`.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#add-long-java.lang.String-java.lang.String-">add</a></span>(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Asserts the value of attribute `keyword` to be the provided `value`.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#add-long-java.lang.String-java.util.UUID-">add</a></span>(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
<a href="https://developer.android.com/reference/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;value)</code>
<div class="block">Asserts the value of attribute `keyword` to be the provided `value`.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#addKeyword-long-java.lang.String-java.lang.String-">addKeyword</a></span>(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Asserts the value of attribute `keyword` to be the provided `value`.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#addRef-long-java.lang.String-long-">addRef</a></span>(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
long&nbsp;value)</code>
<div class="block">Asserts the value of attribute `keyword` to be the provided `value`.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#close--">close</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../org/mozilla/mentat/TxReport.html" title="class in org.mozilla.mentat">TxReport</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#commit--">commit</a></span>()</code>
<div class="block">Transacts the added assertions and commits.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#destroyPointer-org.mozilla.mentat.JNA.InProgressBuilder-">destroyPointer</a></span>(<a href="../../../org/mozilla/mentat/JNA.InProgressBuilder.html" title="class in org.mozilla.mentat">JNA.InProgressBuilder</a>&nbsp;p)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#finalize--">finalize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#retract-long-java.lang.String-boolean-">retract</a></span>(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
boolean&nbsp;value)</code>
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#retract-long-java.lang.String-java.util.Date-">retract</a></span>(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
<a href="https://developer.android.com/reference/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;value)</code>
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#retract-long-java.lang.String-double-">retract</a></span>(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
double&nbsp;value)</code>
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#retract-long-java.lang.String-long-">retract</a></span>(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
long&nbsp;value)</code>
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#retract-long-java.lang.String-java.lang.String-">retract</a></span>(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#retract-long-java.lang.String-java.util.UUID-">retract</a></span>(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
<a href="https://developer.android.com/reference/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;value)</code>
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#retractKeyword-long-java.lang.String-java.lang.String-">retractKeyword</a></span>(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#retractRef-long-java.lang.String-long-">retractRef</a></span>(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
long&nbsp;value)</code>
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../../../org/mozilla/mentat/InProgressTransactionResult.html" title="class in org.mozilla.mentat">InProgressTransactionResult</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/mozilla/mentat/InProgressBuilder.html#transact--">transact</a></span>()</code>
<div class="block">Transacts the added assertions.</div>
</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.<a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="InProgressBuilder-org.mozilla.mentat.JNA.InProgressBuilder-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>InProgressBuilder</h4>
<pre>public&nbsp;InProgressBuilder(<a href="../../../org/mozilla/mentat/JNA.InProgressBuilder.html" title="class in org.mozilla.mentat">JNA.InProgressBuilder</a>&nbsp;pointer)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="add-long-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public&nbsp;void&nbsp;add(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
long&nbsp;value)</pre>
<div class="block">Asserts the value of attribute `keyword` to be the provided `value`.
// TODO throw exception if error occurs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entid</code> - The `Entid` of the entity to be touched.</dd>
<dd><code>keyword</code> - The name of the attribute in the format `:namespace/name`.</dd>
<dd><code>value</code> - The value to be asserted</dd>
</dl>
</li>
</ul>
<a name="addRef-long-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addRef</h4>
<pre>public&nbsp;void&nbsp;addRef(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
long&nbsp;value)</pre>
<div class="block">Asserts the value of attribute `keyword` to be the provided `value`.
// TODO throw exception if error occurs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entid</code> - The `Entid` of the entity to be touched.</dd>
<dd><code>keyword</code> - The name of the attribute in the format `:namespace/name`.</dd>
<dd><code>value</code> - The value to be asserted</dd>
</dl>
</li>
</ul>
<a name="addKeyword-long-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addKeyword</h4>
<pre>public&nbsp;void&nbsp;addKeyword(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block">Asserts the value of attribute `keyword` to be the provided `value`.
// TODO throw exception if error occurs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entid</code> - The `Entid` of the entity to be touched.</dd>
<dd><code>keyword</code> - The name of the attribute in the format `:namespace/name`.</dd>
<dd><code>value</code> - The value to be asserted</dd>
</dl>
</li>
</ul>
<a name="add-long-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public&nbsp;void&nbsp;add(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
boolean&nbsp;value)</pre>
<div class="block">Asserts the value of attribute `keyword` to be the provided `value`.
// TODO throw exception if error occurs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entid</code> - The `Entid` of the entity to be touched.</dd>
<dd><code>keyword</code> - The name of the attribute in the format `:namespace/name`.</dd>
<dd><code>value</code> - The value to be asserted</dd>
</dl>
</li>
</ul>
<a name="add-long-java.lang.String-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public&nbsp;void&nbsp;add(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
double&nbsp;value)</pre>
<div class="block">Asserts the value of attribute `keyword` to be the provided `value`.
// TODO throw exception if error occurs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entid</code> - The `Entid` of the entity to be touched.</dd>
<dd><code>keyword</code> - The name of the attribute in the format `:namespace/name`.</dd>
<dd><code>value</code> - The value to be asserted</dd>
</dl>
</li>
</ul>
<a name="add-long-java.lang.String-java.util.Date-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public&nbsp;void&nbsp;add(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
<a href="https://developer.android.com/reference/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;value)</pre>
<div class="block">Asserts the value of attribute `keyword` to be the provided `value`.
// TODO throw exception if error occurs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entid</code> - The `Entid` of the entity to be touched.</dd>
<dd><code>keyword</code> - The name of the attribute in the format `:namespace/name`.</dd>
<dd><code>value</code> - The value to be asserted</dd>
</dl>
</li>
</ul>
<a name="add-long-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public&nbsp;void&nbsp;add(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block">Asserts the value of attribute `keyword` to be the provided `value`.
// TODO throw exception if error occurs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entid</code> - The `Entid` of the entity to be touched.</dd>
<dd><code>keyword</code> - The name of the attribute in the format `:namespace/name`.</dd>
<dd><code>value</code> - The value to be asserted</dd>
</dl>
</li>
</ul>
<a name="add-long-java.lang.String-java.util.UUID-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public&nbsp;void&nbsp;add(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
<a href="https://developer.android.com/reference/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;value)</pre>
<div class="block">Asserts the value of attribute `keyword` to be the provided `value`.
// TODO throw exception if error occurs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entid</code> - The `Entid` of the entity to be touched.</dd>
<dd><code>keyword</code> - The name of the attribute in the format `:namespace/name`.</dd>
<dd><code>value</code> - The value to be asserted</dd>
</dl>
</li>
</ul>
<a name="retract-long-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retract</h4>
<pre>public&nbsp;void&nbsp;retract(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
long&nbsp;value)</pre>
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.
TODO throw exception if error occurs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entid</code> - The `Entid` of the entity to be touched.</dd>
<dd><code>keyword</code> - The name of the attribute in the format `:namespace/name`.</dd>
<dd><code>value</code> - The value to be retracted</dd>
</dl>
</li>
</ul>
<a name="retractRef-long-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retractRef</h4>
<pre>public&nbsp;void&nbsp;retractRef(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
long&nbsp;value)</pre>
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.
TODO throw exception if error occurs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entid</code> - The `Entid` of the entity to be touched.</dd>
<dd><code>keyword</code> - The name of the attribute in the format `:namespace/name`.</dd>
<dd><code>value</code> - The value to be retracted</dd>
</dl>
</li>
</ul>
<a name="retractKeyword-long-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retractKeyword</h4>
<pre>public&nbsp;void&nbsp;retractKeyword(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.
TODO throw exception if error occurs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entid</code> - The `Entid` of the entity to be touched.</dd>
<dd><code>keyword</code> - The name of the attribute in the format `:namespace/name`.</dd>
<dd><code>value</code> - The value to be retracted</dd>
</dl>
</li>
</ul>
<a name="retract-long-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retract</h4>
<pre>public&nbsp;void&nbsp;retract(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
boolean&nbsp;value)</pre>
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.
TODO throw exception if error occurs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entid</code> - The `Entid` of the entity to be touched.</dd>
<dd><code>keyword</code> - The name of the attribute in the format `:namespace/name`.</dd>
<dd><code>value</code> - The value to be retracted</dd>
</dl>
</li>
</ul>
<a name="retract-long-java.lang.String-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retract</h4>
<pre>public&nbsp;void&nbsp;retract(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
double&nbsp;value)</pre>
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.
TODO throw exception if error occurs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entid</code> - The `Entid` of the entity to be touched.</dd>
<dd><code>keyword</code> - The name of the attribute in the format `:namespace/name`.</dd>
<dd><code>value</code> - The value to be retracted</dd>
</dl>
</li>
</ul>
<a name="retract-long-java.lang.String-java.util.Date-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retract</h4>
<pre>public&nbsp;void&nbsp;retract(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
<a href="https://developer.android.com/reference/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;value)</pre>
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.
TODO throw exception if error occurs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entid</code> - The `Entid` of the entity to be touched.</dd>
<dd><code>keyword</code> - The name of the attribute in the format `:namespace/name`.</dd>
<dd><code>value</code> - The value to be retracted</dd>
</dl>
</li>
</ul>
<a name="retract-long-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retract</h4>
<pre>public&nbsp;void&nbsp;retract(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.
TODO throw exception if error occurs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entid</code> - The `Entid` of the entity to be touched.</dd>
<dd><code>keyword</code> - The name of the attribute in the format `:namespace/name`.</dd>
<dd><code>value</code> - The value to be retracted</dd>
</dl>
</li>
</ul>
<a name="retract-long-java.lang.String-java.util.UUID-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retract</h4>
<pre>public&nbsp;void&nbsp;retract(long&nbsp;entid,
<a href="https://developer.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keyword,
<a href="https://developer.android.com/reference/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;value)</pre>
<div class="block">Retracts the value of attribute `keyword` from the provided `value`.
TODO throw exception if error occurs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entid</code> - The `Entid` of the entity to be touched.</dd>
<dd><code>keyword</code> - The name of the attribute in the format `:namespace/name`.</dd>
<dd><code>value</code> - The value to be retracted</dd>
</dl>
</li>
</ul>
<a name="transact--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transact</h4>
<pre>public&nbsp;<a href="../../../org/mozilla/mentat/InProgressTransactionResult.html" title="class in org.mozilla.mentat">InProgressTransactionResult</a>&nbsp;transact()</pre>
<div class="block">Transacts the added assertions. This consumes the pointer associated with this <a href="../../../org/mozilla/mentat/InProgressBuilder.html" title="class in org.mozilla.mentat"><code>InProgressBuilder</code></a>
such that no further assertions can be added after the `transact` has completed. To perform
further assertions, use the <a href="../../../org/mozilla/mentat/InProgress.html" title="class in org.mozilla.mentat"><code>InProgress</code></a> inside the <a href="../../../org/mozilla/mentat/InProgressTransactionResult.html" title="class in org.mozilla.mentat"><code>InProgressTransactionResult</code></a>
returned from this function.
<p/>
This does not commit the transaction. In order to do so, `commit` can be called on the
<a href="../../../org/mozilla/mentat/InProgress.html" title="class in org.mozilla.mentat"><code>InProgress</code></a> inside the <a href="../../../org/mozilla/mentat/InProgressTransactionResult.html" title="class in org.mozilla.mentat"><code>InProgressTransactionResult</code></a> returned from this function.
TODO throw exception if error occurs</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <a href="../../../org/mozilla/mentat/InProgressTransactionResult.html" title="class in org.mozilla.mentat"><code>InProgressTransactionResult</code></a> containing the current <a href="../../../org/mozilla/mentat/InProgress.html" title="class in org.mozilla.mentat"><code>InProgress</code></a> and
the <a href="../../../org/mozilla/mentat/TxReport.html" title="class in org.mozilla.mentat"><code>TxReport</code></a> generated by the transact.</dd>
</dl>
</li>
</ul>
<a name="commit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commit</h4>
<pre>public&nbsp;<a href="../../../org/mozilla/mentat/TxReport.html" title="class in org.mozilla.mentat">TxReport</a>&nbsp;commit()</pre>
<div class="block">Transacts the added assertions and commits. This consumes the pointer associated with this
<a href="../../../org/mozilla/mentat/InProgressBuilder.html" title="class in org.mozilla.mentat"><code>InProgressBuilder</code></a> and the associated <a href="../../../org/mozilla/mentat/InProgress.html" title="class in org.mozilla.mentat"><code>InProgress</code></a> such that no further assertions
can be added after the `commit` has completed.
<p/>
To perform further assertions, a new `<a href="../../../org/mozilla/mentat/InProgress.html" title="class in org.mozilla.mentat"><code>InProgress</code></a> or <a href="../../../org/mozilla/mentat/InProgressBuilder.html" title="class in org.mozilla.mentat"><code>InProgressBuilder</code></a> should be
created.
TODO throw exception if error occurs</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <a href="../../../org/mozilla/mentat/TxReport.html" title="class in org.mozilla.mentat"><code>TxReport</code></a> generated by the commit.</dd>
</dl>
</li>
</ul>
<a name="destroyPointer-org.mozilla.mentat.JNA.InProgressBuilder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destroyPointer</h4>
<pre>protected&nbsp;void&nbsp;destroyPointer(<a href="../../../org/mozilla/mentat/JNA.InProgressBuilder.html" title="class in org.mozilla.mentat">JNA.InProgressBuilder</a>&nbsp;p)</pre>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<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="https://developer.android.com/reference/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://developer.android.com/reference/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
</dl>
</li>
</ul>
<a name="finalize--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>finalize</h4>
<pre>protected&nbsp;void&nbsp;finalize()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a></code>&nbsp;in class&nbsp;<code><a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../org/mozilla/mentat/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/mozilla/mentat/InProgress.html" title="class in org.mozilla.mentat"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/mozilla/mentat/InProgressTransactionResult.html" title="class in org.mozilla.mentat"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/mozilla/mentat/InProgressBuilder.html" target="_top">Frames</a></li>
<li><a href="InProgressBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in a new issue View git blame Copy permalink