blob: 7ff67bf1c944cbfb51f095dee2593848d39e9dfa [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>PagedReference (ActiveMQ Artemis Website 2.29.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<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="PagedReference (ActiveMQ Artemis Website 2.29.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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";
</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/PagedReference.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="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.activemq.artemis.core.paging.cursor</a></div>
<h2 title="Interface PagedReference" class="title">Interface PagedReference</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="../../server/MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="PagedReferenceImpl.html" title="class in org.apache.activemq.artemis.core.paging.cursor">PagedReferenceImpl</a></code>, <code><a href="QueryPagedReferenceImpl.html" title="class in org.apache.activemq.artemis.core.paging.cursor">QueryPagedReferenceImpl</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">PagedReference</span>
extends <a href="../../server/MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.activemq.artemis.core.server.MessageReference">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.activemq.artemis.core.server.<a href="../../server/MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a></h3>
<code><a href="../../server/MessageReference.Factory.html" title="class in org.apache.activemq.artemis.core.server">MessageReference.Factory</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<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">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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="#addPendingFlag()">addPendingFlag</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../PagedMessage.html" title="interface in org.apache.activemq.artemis.core.paging">PagedMessage</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPagedMessage()">getPagedMessage</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="PagePosition.html" title="interface in org.apache.activemq.artemis.core.paging.cursor">PagePosition</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPosition()">getPosition</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTransactionID()">getTransactionID</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLargeMessage()">isLargeMessage</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removePendingFlag()">removePendingFlag</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.activemq.artemis.core.server.MessageReference">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.activemq.artemis.core.server.<a href="../../server/MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a></h3>
<code><a href="../../server/MessageReference.html#acknowledge()">acknowledge</a>, <a href="../../server/MessageReference.html#acknowledge(org.apache.activemq.artemis.core.transaction.Transaction)">acknowledge</a>, <a href="../../server/MessageReference.html#acknowledge(org.apache.activemq.artemis.core.transaction.Transaction,org.apache.activemq.artemis.core.server.impl.AckReason,org.apache.activemq.artemis.core.server.ServerConsumer)">acknowledge</a>, <a href="../../server/MessageReference.html#acknowledge(org.apache.activemq.artemis.core.transaction.Transaction,org.apache.activemq.artemis.core.server.ServerConsumer)">acknowledge</a>, <a href="../../server/MessageReference.html#copy(org.apache.activemq.artemis.core.server.Queue)">copy</a>, <a href="../../server/MessageReference.html#decrementDeliveryCount()">decrementDeliveryCount</a>, <a href="../../server/MessageReference.html#emptyConsumerID()">emptyConsumerID</a>, <a href="../../server/MessageReference.html#getConsumerId()">getConsumerId</a>, <a href="../../server/MessageReference.html#getDeliveryCount()">getDeliveryCount</a>, <a href="../../server/MessageReference.html#getLastValueProperty()">getLastValueProperty</a>, <a href="../../server/MessageReference.html#getMessage()">getMessage</a>, <a href="../../server/MessageReference.html#getMessageID()">getMessageID</a>, <a href="../../server/MessageReference.html#getMessageMemoryEstimate()">getMessageMemoryEstimate</a>, <a href="../../server/MessageReference.html#getPersistedCount()">getPersistedCount</a>, <a href="../../server/MessageReference.html#getPersistentSize()">getPersistentSize</a>, <a href="../../server/MessageReference.html#getProtocolData(java.lang.Class)">getProtocolData</a>, <a href="../../server/MessageReference.html#getQueue()">getQueue</a>, <a href="../../server/MessageReference.html#getScheduledDeliveryTime()">getScheduledDeliveryTime</a>, <a href="../../server/MessageReference.html#handled()">handled</a>, <a href="../../server/MessageReference.html#hasConsumerId()">hasConsumerId</a>, <a href="../../server/MessageReference.html#incrementDeliveryCount()">incrementDeliveryCount</a>, <a href="../../server/MessageReference.html#isAlreadyAcked()">isAlreadyAcked</a>, <a href="../../server/MessageReference.html#isDurable()">isDurable</a>, <a href="../../server/MessageReference.html#isInDelivery()">isInDelivery</a>, <a href="../../server/MessageReference.html#isPaged()">isPaged</a>, <a href="../../server/MessageReference.html#onDelivery(java.util.function.Consumer)">onDelivery</a>, <a href="../../server/MessageReference.html#setAlreadyAcked()">setAlreadyAcked</a>, <a href="../../server/MessageReference.html#setConsumerId(long)">setConsumerId</a>, <a href="../../server/MessageReference.html#setDeliveryCount(int)">setDeliveryCount</a>, <a href="../../server/MessageReference.html#setInDelivery(boolean)">setInDelivery</a>, <a href="../../server/MessageReference.html#setPersistedCount(int)">setPersistedCount</a>, <a href="../../server/MessageReference.html#setProtocolData(java.lang.Class,T)">setProtocolData</a>, <a href="../../server/MessageReference.html#setScheduledDeliveryTime(long)">setScheduledDeliveryTime</a>, <a href="../../server/MessageReference.html#skipDelivery()">skipDelivery</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getPosition()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPosition</h4>
<pre class="methodSignature"><a href="PagePosition.html" title="interface in org.apache.activemq.artemis.core.paging.cursor">PagePosition</a>&nbsp;getPosition()</pre>
</li>
</ul>
<a id="getPagedMessage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPagedMessage</h4>
<pre class="methodSignature"><a href="../PagedMessage.html" title="interface in org.apache.activemq.artemis.core.paging">PagedMessage</a>&nbsp;getPagedMessage()</pre>
</li>
</ul>
<a id="isLargeMessage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLargeMessage</h4>
<pre class="methodSignature">boolean&nbsp;isLargeMessage()</pre>
</li>
</ul>
<a id="getTransactionID()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransactionID</h4>
<pre class="methodSignature">long&nbsp;getTransactionID()</pre>
</li>
</ul>
<a id="addPendingFlag()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPendingFlag</h4>
<pre class="methodSignature">void&nbsp;addPendingFlag()</pre>
</li>
</ul>
<a id="removePendingFlag()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removePendingFlag</h4>
<pre class="methodSignature">void&nbsp;removePendingFlag()</pre>
</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/PagedReference.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="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</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 &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>