| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Seq (OpenJPA Parent POM 4.1.1 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/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="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Seq (OpenJPA Parent POM 4.1.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Seq.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.openjpa.kernel</a></div> |
| <h2 title="Interface Seq" class="title">Interface Seq</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="../jdbc/kernel/JDBCSeq.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCSeq</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../jdbc/kernel/AbstractJDBCSeq.html" title="class in org.apache.openjpa.jdbc.kernel">AbstractJDBCSeq</a></code>, <code><a href="../jdbc/kernel/ClassTableJDBCSeq.html" title="class in org.apache.openjpa.jdbc.kernel">ClassTableJDBCSeq</a></code>, <code><a href="DelegatingSeq.html" title="class in org.apache.openjpa.kernel">DelegatingSeq</a></code>, <code><a href="../jdbc/kernel/NativeJDBCSeq.html" title="class in org.apache.openjpa.jdbc.kernel">NativeJDBCSeq</a></code>, <code><a href="../jdbc/kernel/TableJDBCSeq.html" title="class in org.apache.openjpa.jdbc.kernel">TableJDBCSeq</a></code>, <code><a href="TimeSeededSeq.html" title="class in org.apache.openjpa.kernel">TimeSeededSeq</a></code>, <code><a href="UUIDHexSeq.html" title="class in org.apache.openjpa.kernel">UUIDHexSeq</a></code>, <code><a href="UUIDStringSeq.html" title="class in org.apache.openjpa.kernel">UUIDStringSeq</a></code>, <code><a href="UUIDType4HexSeq.html" title="class in org.apache.openjpa.kernel">UUIDType4HexSeq</a></code>, <code><a href="UUIDType4StringSeq.html" title="class in org.apache.openjpa.kernel">UUIDType4StringSeq</a></code>, <code><a href="../jdbc/kernel/ValueTableJDBCSeq.html" title="class in org.apache.openjpa.jdbc.kernel">ValueTableJDBCSeq</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Seq</span> |
| extends <a href="../lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></pre> |
| <div class="block">Internal OpenJPA sequence interface.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Abe White</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TYPE_CONTIGUOUS">TYPE_CONTIGUOUS</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TYPE_DEFAULT">TYPE_DEFAULT</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TYPE_NONTRANSACTIONAL">TYPE_NONTRANSACTIONAL</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TYPE_TRANSACTIONAL">TYPE_TRANSACTIONAL</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allocate(int,org.apache.openjpa.kernel.StoreContext,org.apache.openjpa.meta.ClassMetaData)">allocate</a></span>​(int additional, |
| <a href="StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx, |
| <a href="../meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> cls)</code></th> |
| <td class="colLast"> |
| <div class="block">Allocate additional values efficiently.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Free resources used by this sequence.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#current(org.apache.openjpa.kernel.StoreContext,org.apache.openjpa.meta.ClassMetaData)">current</a></span>​(<a href="StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx, |
| <a href="../meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> cls)</code></th> |
| <td class="colLast"> |
| <div class="block">Return the current value of the sequence, or null if not available.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#next(org.apache.openjpa.kernel.StoreContext,org.apache.openjpa.meta.ClassMetaData)">next</a></span>​(<a href="StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx, |
| <a href="../meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> cls)</code></th> |
| <td class="colLast"> |
| <div class="block">Return the next value in the sequence.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setType(int)">setType</a></span>​(int type)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the type of sequence.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="TYPE_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TYPE_DEFAULT</h4> |
| <pre>static final int TYPE_DEFAULT</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.openjpa.kernel.Seq.TYPE_DEFAULT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="TYPE_NONTRANSACTIONAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TYPE_NONTRANSACTIONAL</h4> |
| <pre>static final int TYPE_NONTRANSACTIONAL</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.openjpa.kernel.Seq.TYPE_NONTRANSACTIONAL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="TYPE_TRANSACTIONAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TYPE_TRANSACTIONAL</h4> |
| <pre>static final int TYPE_TRANSACTIONAL</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.openjpa.kernel.Seq.TYPE_TRANSACTIONAL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="TYPE_CONTIGUOUS"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TYPE_CONTIGUOUS</h4> |
| <pre>static final int TYPE_CONTIGUOUS</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.openjpa.kernel.Seq.TYPE_CONTIGUOUS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="setType(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setType</h4> |
| <pre class="methodSignature">void setType​(int type)</pre> |
| <div class="block">Set the type of sequence.</div> |
| </li> |
| </ul> |
| <a id="next(org.apache.openjpa.kernel.StoreContext,org.apache.openjpa.meta.ClassMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>next</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> next​(<a href="StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx, |
| <a href="../meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> cls)</pre> |
| <div class="block">Return the next value in the sequence.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - the current context</dd> |
| <dd><code>cls</code> - if this is a datastore identity sequence, the |
| persistent class the identity value is for; else null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="current(org.apache.openjpa.kernel.StoreContext,org.apache.openjpa.meta.ClassMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>current</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> current​(<a href="StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx, |
| <a href="../meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> cls)</pre> |
| <div class="block">Return the current value of the sequence, or null if not available.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - the current context</dd> |
| <dd><code>cls</code> - if this is a datastore identity sequence, the |
| persistent class the identity value is for; else null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="allocate(int,org.apache.openjpa.kernel.StoreContext,org.apache.openjpa.meta.ClassMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocate</h4> |
| <pre class="methodSignature">void allocate​(int additional, |
| <a href="StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx, |
| <a href="../meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> cls)</pre> |
| <div class="block">Allocate additional values efficiently.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - the current context</dd> |
| <dd><code>cls</code> - if this is a datastore identity sequence, the |
| persistent class the identity value is for; else null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">void close()</pre> |
| <div class="block">Free resources used by this sequence.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../lib/util/Closeable.html#close()">close</a></code> in interface <code><a href="../lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Seq.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All 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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2006–2025 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
