mentat/docs/apis/java/0.1/overview-tree.html
Emily Toop c5180656cc
Mentat documentation website using Jekyll (#754)
Steps to building docs locally:

    1. Install Jekyll
    2. cd docs
    3. bundle exec jekyll serve --incremental
    4. open local docs site at http://127.0.0.1:4000/


* basic Jekyll site

* Add docs to documentation site

* Update javadoc to allow for error free builds

* Remove docs for rust dependencies

* Better display examples, about and contributing documentation for Mentat

* Version docs
2018-06-25 11:20:36 +01:00

210 lines
13 KiB
HTML

<!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 21 13:35:13 BST 2018 -->
<title>Class Hierarchy</title>
<meta name="date" content="2018-06-21">
<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="Class Hierarchy";
}
}
catch(err) {
}
//-->
</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</li>
<li class="navBarCell1Rev">Tree</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-tree.html" target="_top">Frames</a></li>
<li><a href="overview-tree.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 class="title">Hierarchy For All Packages</h1>
<span class="packageHierarchyLabel">Package Hierarchies:</span>
<ul class="horizontal">
<li><a href="org/mozilla/mentat/package-tree.html">org.mozilla.mentat</a></li>
</ul>
</div>
<div class="contentContainer">
<h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li type="circle">java.lang.<a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true" title="class or interface in java.lang"><span class="typeNameLink">Object</span></a>
<ul>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/ColResultIterator.html" title="class in org.mozilla.mentat"><span class="typeNameLink">ColResultIterator</span></a> (implements java.util.<a href="https://developer.android.com/reference/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;E&gt;)</li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/EntityBuilder.html" title="class in org.mozilla.mentat"><span class="typeNameLink">EntityBuilder</span></a></li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/InProgress.html" title="class in org.mozilla.mentat"><span class="typeNameLink">InProgress</span></a></li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/InProgressBuilder.html" title="class in org.mozilla.mentat"><span class="typeNameLink">InProgressBuilder</span></a></li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/Mentat.html" title="class in org.mozilla.mentat"><span class="typeNameLink">Mentat</span></a></li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/Query.html" title="class in org.mozilla.mentat"><span class="typeNameLink">Query</span></a></li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/RelResult.html" title="class in org.mozilla.mentat"><span class="typeNameLink">RelResult</span></a> (implements java.lang.<a href="https://developer.android.com/reference/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;T&gt;)</li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/RelResultIterator.html" title="class in org.mozilla.mentat"><span class="typeNameLink">RelResultIterator</span></a> (implements java.util.<a href="https://developer.android.com/reference/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;E&gt;)</li>
<li type="circle">com.sun.jna.Structure
<ul>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/AttributeList.html" title="class in org.mozilla.mentat"><span class="typeNameLink">AttributeList</span></a> (implements java.io.<a href="https://developer.android.com/reference/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>)
<ul>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/AttributeList.ByReference.html" title="class in org.mozilla.mentat"><span class="typeNameLink">AttributeList.ByReference</span></a> (implements com.sun.jna.Structure.ByReference)</li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/AttributeList.ByValue.html" title="class in org.mozilla.mentat"><span class="typeNameLink">AttributeList.ByValue</span></a> (implements com.sun.jna.Structure.ByValue)</li>
</ul>
</li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/InProgressTransactionResult.html" title="class in org.mozilla.mentat"><span class="typeNameLink">InProgressTransactionResult</span></a> (implements java.io.<a href="https://developer.android.com/reference/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>)
<ul>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/InProgressTransactionResult.ByReference.html" title="class in org.mozilla.mentat"><span class="typeNameLink">InProgressTransactionResult.ByReference</span></a> (implements com.sun.jna.Structure.ByReference)</li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/InProgressTransactionResult.ByValue.html" title="class in org.mozilla.mentat"><span class="typeNameLink">InProgressTransactionResult.ByValue</span></a> (implements com.sun.jna.Structure.ByValue)</li>
</ul>
</li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/RustResult.html" title="class in org.mozilla.mentat"><span class="typeNameLink">RustResult</span></a> (implements java.io.<a href="https://developer.android.com/reference/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>)
<ul>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/RustResult.ByReference.html" title="class in org.mozilla.mentat"><span class="typeNameLink">RustResult.ByReference</span></a> (implements com.sun.jna.Structure.ByReference)</li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/RustResult.ByValue.html" title="class in org.mozilla.mentat"><span class="typeNameLink">RustResult.ByValue</span></a> (implements com.sun.jna.Structure.ByValue)</li>
</ul>
</li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/TxChange.html" title="class in org.mozilla.mentat"><span class="typeNameLink">TxChange</span></a> (implements java.io.<a href="https://developer.android.com/reference/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>)
<ul>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/TxChange.ByReference.html" title="class in org.mozilla.mentat"><span class="typeNameLink">TxChange.ByReference</span></a> (implements com.sun.jna.Structure.ByReference)</li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/TxChange.ByValue.html" title="class in org.mozilla.mentat"><span class="typeNameLink">TxChange.ByValue</span></a> (implements com.sun.jna.Structure.ByValue)</li>
</ul>
</li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/TxChangeList.html" title="class in org.mozilla.mentat"><span class="typeNameLink">TxChangeList</span></a> (implements java.io.<a href="https://developer.android.com/reference/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>)
<ul>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/TxChangeList.ByReference.html" title="class in org.mozilla.mentat"><span class="typeNameLink">TxChangeList.ByReference</span></a> (implements com.sun.jna.Structure.ByReference)</li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/TxChangeList.ByValue.html" title="class in org.mozilla.mentat"><span class="typeNameLink">TxChangeList.ByValue</span></a> (implements com.sun.jna.Structure.ByValue)</li>
</ul>
</li>
</ul>
</li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/TupleResult.html" title="class in org.mozilla.mentat"><span class="typeNameLink">TupleResult</span></a>
<ul>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/CollResult.html" title="class in org.mozilla.mentat"><span class="typeNameLink">CollResult</span></a> (implements java.lang.<a href="https://developer.android.com/reference/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;T&gt;)</li>
</ul>
</li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/TxReport.html" title="class in org.mozilla.mentat"><span class="typeNameLink">TxReport</span></a></li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/TypedValue.html" title="class in org.mozilla.mentat"><span class="typeNameLink">TypedValue</span></a></li>
</ul>
</li>
</ul>
<h2 title="Interface Hierarchy">Interface Hierarchy</h2>
<ul>
<li type="circle">com.sun.jna.Callback
<ul>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/TxObserverCallback.html" title="interface in org.mozilla.mentat"><span class="typeNameLink">TxObserverCallback</span></a></li>
</ul>
</li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/CollResultHandler.html" title="interface in org.mozilla.mentat"><span class="typeNameLink">CollResultHandler</span></a></li>
<li type="circle">com.sun.jna.Library
<ul>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/JNA.html" title="interface in org.mozilla.mentat"><span class="typeNameLink">JNA</span></a></li>
</ul>
</li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/RelResultHandler.html" title="interface in org.mozilla.mentat"><span class="typeNameLink">RelResultHandler</span></a></li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/ScalarResultHandler.html" title="interface in org.mozilla.mentat"><span class="typeNameLink">ScalarResultHandler</span></a></li>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/TupleResultHandler.html" title="interface in org.mozilla.mentat"><span class="typeNameLink">TupleResultHandler</span></a></li>
</ul>
<h2 title="Enum Hierarchy">Enum Hierarchy</h2>
<ul>
<li type="circle">java.lang.<a href="https://developer.android.com/reference/java/lang/Object.html?is-external=true" title="class or interface in java.lang"><span class="typeNameLink">Object</span></a>
<ul>
<li type="circle">java.lang.<a href="https://developer.android.com/reference/java/lang/Enum.html?is-external=true" title="class or interface in java.lang"><span class="typeNameLink">Enum</span></a>&lt;E&gt; (implements java.lang.<a href="https://developer.android.com/reference/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;T&gt;, java.io.<a href="https://developer.android.com/reference/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>)
<ul>
<li type="circle">org.mozilla.mentat.<a href="org/mozilla/mentat/CacheDirection.html" title="enum in org.mozilla.mentat"><span class="typeNameLink">CacheDirection</span></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= 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</li>
<li class="navBarCell1Rev">Tree</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-tree.html" target="_top">Frames</a></li>
<li><a href="overview-tree.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>