docs: update javadocs

Signed-off-by: Otavio Santana <[email protected]>
JNOSQL · Mar 23, 2024 · 368e2b8 · 368e2b8
1 parent 043aacc
commit 368e2b8
Show file tree

Hide file tree

Showing 105 changed files with 5,569 additions and 4,688 deletions.
diff --git a/javadoc/allclasses-index.html b/javadoc/allclasses-index.html
diff --git a/javadoc/allpackages-index.html b/javadoc/allpackages-index.html
@@ -1,15 +1,14 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) -->
-<title>All Packages (api-parent 1.0.0-b7 API)</title>
+<!-- Generated by javadoc (21) -->
+<title>All Packages (Jakarta NoSQL API 1.0.0-M1 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="package index">
 <meta name="generator" content="javadoc/AllPackagesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
-<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 <script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
 <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
@@ -24,23 +23,23 @@
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
-<div class="top-nav" id="navbar-top">
+<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
-<li><a href="index.html">Overview</a></li>
-<li>Module</li>
-<li>Package</li>
+<li><a href="jakarta.nosql.core/module-summary.html">Module</a></li>
+<li><a href="jakarta.nosql.core/jakarta/nosql/package-summary.html">Package</a></li>
 <li>Class</li>
 <li>Use</li>
-<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="jakarta.nosql.core/jakarta/nosql/package-tree.html">Tree</a></li>
 <li><a href="index-all.html">Index</a></li>
 <li><a href="help-doc.html#all-packages">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
-<div class="nav-list-search"><label for="search-input">SEARCH:</label>
-<input type="text" id="search-input" value="search" disabled="disabled">
-<input type="reset" id="reset-button" value="reset" disabled="disabled">
+<div id="navbar-sub-list"></div>
+<div class="nav-list-search"><a href="search.html">SEARCH</a>
+<input type="text" id="search-input" disabled placeholder="Search">
+<input type="reset" id="reset-button" disabled value="reset">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
@@ -57,19 +56,7 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><a href="jakarta.nosql.core/jakarta/nosql/package-summary.html">jakarta.nosql</a></div>
 <div class="col-last even-row-color">
-<div class="block">Defines the core API in mapping level.</div>
-</div>
-<div class="col-first odd-row-color"><a href="jakarta.nosql.column/jakarta/nosql/column/package-summary.html">jakarta.nosql.column</a></div>
-<div class="col-last odd-row-color">
-<div class="block">Defines the API to Column Family in mapping level.</div>
-</div>
-<div class="col-first even-row-color"><a href="jakarta.nosql.document/jakarta/nosql/document/package-summary.html">jakarta.nosql.document</a></div>
-<div class="col-last even-row-color">
-<div class="block">Defines the API to Document Collection in mapping level.</div>
-</div>
-<div class="col-first odd-row-color"><a href="jakarta.nosql.keyvalue/jakarta/nosql/keyvalue/package-summary.html">jakarta.nosql.keyvalue</a></div>
-<div class="col-last odd-row-color">
-<div class="block">Defines the API to Key-value in mapping level.</div>
+<div class="block">Provides classes and interfaces for integrating Java applications with various NoSQL databases.</div>
 </div>
 </div>
 </main>

diff --git a/javadoc/constant-values.html b/javadoc/constant-values.html
@@ -0,0 +1,83 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<!-- Generated by javadoc (21) -->
+<title>Constant Field Values (Jakarta NoSQL API 1.0.0-M1 API)</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta name="description" content="summary of constants">
+<meta name="generator" content="javadoc/ConstantsSummaryWriterImpl">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
+<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
+</head>
+<body class="constants-summary-page">
+<script type="text/javascript">var pathtoroot = "./";
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<div class="flex-box">
+<header role="banner" class="flex-header">
+<nav role="navigation">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
+<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
+<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
+<li><a href="jakarta.nosql.core/module-summary.html">Module</a></li>
+<li><a href="jakarta.nosql.core/jakarta/nosql/package-summary.html">Package</a></li>
+<li>Class</li>
+<li>Use</li>
+<li><a href="jakarta.nosql.core/jakarta/nosql/package-tree.html">Tree</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html#constant-values">Help</a></li>
+</ul>
+</div>
+<div class="sub-nav">
+<div id="navbar-sub-list"></div>
+<div class="nav-list-search"><a href="search.html">SEARCH</a>
+<input type="text" id="search-input" disabled placeholder="Search">
+<input type="reset" id="reset-button" disabled value="reset">
+</div>
+</div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<span class="skip-nav" id="skip-navbar-top"></span></nav>
+</header>
+<div class="flex-content">
+<main role="main">
+<div class="header">
+<h1 title="Constant Field Values" class="title">Constant Field Values</h1>
+</div>
+<section class="packages">
+<h2 title="Contents">Contents</h2>
+<ul class="contents-list">
+<li><a href="#jakarta.nosql">jakarta.nosql.*</a></li>
+</ul>
+</section>
+<section class="constants-summary" id="jakarta.nosql">
+<h2 title="jakarta.nosql.*">jakarta.nosql.*</h2>
+<ul class="block-list">
+<li>
+<div class="caption"><span>jakarta.nosql.<a href="jakarta.nosql.core/jakarta/nosql/DiscriminatorColumn.html" title="annotation interface in jakarta.nosql">DiscriminatorColumn</a></span></div>
+<div class="summary-table three-column-summary">
+<div class="table-header col-first">Modifier and Type</div>
+<div class="table-header col-second">Constant Field</div>
+<div class="table-header col-last">Value</div>
+<div class="col-first even-row-color"><code id="jakarta.nosql.DiscriminatorColumn.DEFAULT_DISCRIMINATOR_COLUMN">public&nbsp;static&nbsp;final&nbsp;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
+<div class="col-second even-row-color"><code><a href="jakarta.nosql.core/jakarta/nosql/DiscriminatorColumn.html#DEFAULT_DISCRIMINATOR_COLUMN">DEFAULT_DISCRIMINATOR_COLUMN</a></code></div>
+<div class="col-last even-row-color"><code>"dtype"</code></div>
+</div>
+</li>
+</ul>
+</section>
+</main>
+<footer role="contentinfo">
+<hr>
+<p class="legal-copy"><small>Copyright &#169; 2017&#x2013;2020 <a href="https://www.eclipse.org">Eclipse Foundation</a>. All rights reserved.</small></p>
+</footer>
+</div>
+</div>
+</body>
+</html>
diff --git a/javadoc/copy.svg b/javadoc/copy.svg
diff --git a/javadoc/element-list b/javadoc/element-list
@@ -1,8 +1,2 @@
-module:jakarta.nosql.column
-jakarta.nosql.column
 module:jakarta.nosql.core
 jakarta.nosql
-module:jakarta.nosql.document
-jakarta.nosql.document
-module:jakarta.nosql.keyvalue
-jakarta.nosql.keyvalue
diff --git a/javadoc/help-doc.html b/javadoc/help-doc.html
@@ -1,15 +1,14 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) -->
-<title>API Help (api-parent 1.0.0-b7 API)</title>
+<!-- Generated by javadoc (21) -->
+<title>API Help (Jakarta NoSQL API 1.0.0-M1 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="help">
 <meta name="generator" content="javadoc/HelpWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
-<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 <script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
 <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
@@ -24,30 +23,38 @@
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
-<div class="top-nav" id="navbar-top">
+<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
-<li><a href="index.html">Overview</a></li>
-<li>Module</li>
-<li>Package</li>
+<li><a href="jakarta.nosql.core/module-summary.html">Module</a></li>
+<li><a href="jakarta.nosql.core/jakarta/nosql/package-summary.html">Package</a></li>
 <li>Class</li>
 <li>Use</li>
-<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="jakarta.nosql.core/jakarta/nosql/package-tree.html">Tree</a></li>
 <li><a href="index-all.html">Index</a></li>
 <li class="nav-bar-cell1-rev">Help</li>
 </ul>
+<ul class="sub-nav-list-small">
+<li>
+<p>Help:</p>
+<ul>
+<li><a href="#help-navigation">Navigation</a></li>
+<li><a href="#help-pages">Pages</a></li>
+</ul>
+</li>
+</ul>
 </div>
 <div class="sub-nav">
-<div>
+<div id="navbar-sub-list">
 <ul class="sub-nav-list">
 <li>Help:&nbsp;</li>
 <li><a href="#help-navigation">Navigation</a>&nbsp;|&nbsp;</li>
 <li><a href="#help-pages">Pages</a></li>
 </ul>
 </div>
-<div class="nav-list-search"><label for="search-input">SEARCH:</label>
-<input type="text" id="search-input" value="search" disabled="disabled">
-<input type="reset" id="reset-button" value="reset" disabled="disabled">
+<div class="nav-list-search"><a href="search.html">SEARCH</a>
+<input type="text" id="search-input" disabled placeholder="Search">
+<input type="reset" id="reset-button" disabled value="reset">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
@@ -59,18 +66,18 @@ <h1 class="title">JavaDoc Help</h1>
 <ul class="help-toc">
 <li><a href="#help-navigation">Navigation</a>: 
 <ul class="help-subtoc">
-<li><a href="#help-search">Search</a></li>
+<li><a href="#search">Search</a></li>
 </ul>
 </li>
 <li><a href="#help-pages">Kinds of Pages</a>: 
 <ul class="help-subtoc">
-<li><a href="#overview">Overview</a></li>
 <li><a href="#module">Module</a></li>
 <li><a href="#package">Package</a></li>
 <li><a href="#class">Class or Interface</a></li>
 <li><a href="#doc-file">Other Files</a></li>
 <li><a href="#use">Use</a></li>
 <li><a href="#tree">Tree (Class Hierarchy)</a></li>
+<li><a href="#constant-values">Constant Field Values</a></li>
 <li><a href="#serialized-form">Serialized Form</a></li>
 <li><a href="#all-packages">All Packages</a></li>
 <li><a href="#all-classes">All Classes and Interfaces</a></li>
@@ -82,25 +89,21 @@ <h1 class="title">JavaDoc Help</h1>
 <div class="sub-title">
 <h2 id="help-navigation">Navigation</h2>
 Starting from the <a href="index.html">Overview</a> page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The <a href="index-all.html">Index</a> and Search box allow you to navigate to specific declarations and summary pages, including: <a href="allpackages-index.html">All Packages</a>, <a href="allclasses-index.html">All Classes and Interfaces</a>
-<section class="help-section" id="help-search">
+<section class="help-section" id="search">
 <h3>Search</h3>
-<p>You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API, using some or all of the name, optionally using "camelCase" abbreviations. For example:</p>
+<p>You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API. These items can be searched using part or all of the name, optionally using "camelCase" abbreviations, or multiple search terms separated by whitespace. Some examples:</p>
 <ul class="help-section-list">
-<li><code>j.l.obj</code> will match "java.lang.Object"</li>
-<li><code>InpStr</code> will match "java.io.InputStream"</li>
-<li><code>HM.cK</code> will match "java.util.HashMap.containsKey(Object)"</li>
+<li><code>"j.l.obj"</code> matches "java.lang.Object"</li>
+<li><code>"InpStr"</code> matches "java.io.InputStream"</li>
+<li><code>"math exact long"</code> matches "java.lang.Math.absExact(long)"</li>
 </ul>
-<p>Refer to the <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/javadoc-search-spec.html">Javadoc Search Specification</a> for a full description of search features.</p>
+<p>Refer to the <a href="https://docs.oracle.com/en/java/javase/21/docs/specs/javadoc/javadoc-search-spec.html">Javadoc Search Specification</a> for a full description of search features.</p>
 </section>
 </div>
 <hr>
 <div class="sub-title">
 <h2 id="help-pages">Kinds of Pages</h2>
 The following sections describe the different kinds of pages in this collection.
-<section class="help-section" id="overview">
-<h3>Overview</h3>
-<p>The <a href="index.html">Overview</a> page is the front page of this API document and provides a list of all modules with a summary for each.  This page can also contain an overall description of the set of modules.</p>
-</section>
 <section class="help-section" id="module">
 <h3>Module</h3>
 <p>Each module has a page that contains a list of its packages, dependencies on other modules, and services, with a summary for each. These pages may contain the following categories:</p>
@@ -117,8 +120,7 @@ <h3>Package</h3>
 <li>Interfaces</li>
 <li>Classes</li>
 <li>Enum Classes</li>
-<li>Exceptions</li>
-<li>Errors</li>
+<li>Exception Classes</li>
 <li>Annotation Interfaces</li>
 </ul>
 </section>
@@ -172,6 +174,10 @@ <h3>Tree (Class Hierarchy)</h3>
 <li>When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.</li>
 </ul>
 </section>
+<section class="help-section" id="constant-values">
+<h3>Constant Field Values</h3>
+<p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p>
+</section>
 <section class="help-section" id="serialized-form">
 <h3>Serialized Form</h3>
 <p>Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.</p>