blob: ae4ee2b459a1a7ab9516d7bcb3e968eade684a60 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) -->
<title>AsyncGetDataBuilder (Apache Curator 5.8.1-SNAPSHOT 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="declaration: package: org.apache.curator.x.async.api, interface: AsyncGetDataBuilder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<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.7.1.min.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-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="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/AsyncGetDataBuilder.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#class">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li>Nested</li>
<li>Field</li>
<li>Constr</li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li>Constr</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</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">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.curator.x.async.api</a></div>
<h1 title="Interface AsyncGetDataBuilder" class="title">Interface AsyncGetDataBuilder</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="AsyncPathable.html" title="interface in org.apache.curator.x.async.api">AsyncPathable</a>&lt;<a href="../AsyncStage.html" title="interface in org.apache.curator.x.async">AsyncStage</a>&lt;byte[]&gt;&gt;</code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">AsyncGetDataBuilder</span><span class="extends-implements">
extends <a href="AsyncPathable.html" title="interface in org.apache.curator.x.async.api">AsyncPathable</a>&lt;<a href="../AsyncStage.html" title="interface in org.apache.curator.x.async">AsyncStage</a>&lt;byte[]&gt;&gt;</span></div>
<div class="block">Builder to get ZNode data</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="AsyncPathable.html" title="interface in org.apache.curator.x.async.api">AsyncPathable</a><wbr>&lt;<a href="../AsyncStage.html" title="interface in org.apache.curator.x.async">AsyncStage</a>&lt;byte[]&gt;&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#decompressed()" class="member-name-link">decompressed</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Cause the data to be de-compressed using the configured compression provider</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="AsyncPathable.html" title="interface in org.apache.curator.x.async.api">AsyncPathable</a><wbr>&lt;<a href="../AsyncStage.html" title="interface in org.apache.curator.x.async">AsyncStage</a>&lt;byte[]&gt;&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#decompressedStoringStatIn(org.apache.zookeeper.data.Stat)" class="member-name-link">decompressedStoringStatIn</a><wbr>(org.apache.zookeeper.data.Stat&nbsp;stat)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Have the operation fill the provided stat object and have the data be de-compressed</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="AsyncPathable.html" title="interface in org.apache.curator.x.async.api">AsyncPathable</a><wbr>&lt;<a href="../AsyncStage.html" title="interface in org.apache.curator.x.async">AsyncStage</a>&lt;byte[]&gt;&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#storingStatIn(org.apache.zookeeper.data.Stat)" class="member-name-link">storingStatIn</a><wbr>(org.apache.zookeeper.data.Stat&nbsp;stat)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Have the operation fill the provided stat object</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="AsyncPathable.html" title="interface in org.apache.curator.x.async.api">AsyncPathable</a><wbr>&lt;<a href="../AsyncStage.html" title="interface in org.apache.curator.x.async">AsyncStage</a>&lt;byte[]&gt;&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#undecompressed()" class="member-name-link">undecompressed</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Cause the data to not be de-compressed, even if the <a href="../../../framework/CuratorFramework.html" title="interface in org.apache.curator.framework"><code>CuratorFramework</code></a>
has compressionEnabled</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="AsyncPathable.html" title="interface in org.apache.curator.x.async.api">AsyncPathable</a><wbr>&lt;<a href="../AsyncStage.html" title="interface in org.apache.curator.x.async">AsyncStage</a>&lt;byte[]&gt;&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#undecompressedStoringStatIn(org.apache.zookeeper.data.Stat)" class="member-name-link">undecompressedStoringStatIn</a><wbr>(org.apache.zookeeper.data.Stat&nbsp;stat)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Have the operation fill the provided stat object without the data being de-compressed</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.curator.x.async.api.AsyncPathable">Methods inherited from interface&nbsp;org.apache.curator.x.async.api.<a href="AsyncPathable.html" title="interface in org.apache.curator.x.async.api">AsyncPathable</a></h3>
<code><a href="AsyncPathable.html#forPath(java.lang.String)">forPath</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="decompressed()">
<h3>decompressed</h3>
<div class="member-signature"><span class="return-type"><a href="AsyncPathable.html" title="interface in org.apache.curator.x.async.api">AsyncPathable</a>&lt;<a href="../AsyncStage.html" title="interface in org.apache.curator.x.async">AsyncStage</a>&lt;byte[]&gt;&gt;</span>&nbsp;<span class="element-name">decompressed</span>()</div>
<div class="block">Cause the data to be de-compressed using the configured compression provider</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>this</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="undecompressed()">
<h3>undecompressed</h3>
<div class="member-signature"><span class="return-type"><a href="AsyncPathable.html" title="interface in org.apache.curator.x.async.api">AsyncPathable</a>&lt;<a href="../AsyncStage.html" title="interface in org.apache.curator.x.async">AsyncStage</a>&lt;byte[]&gt;&gt;</span>&nbsp;<span class="element-name">undecompressed</span>()</div>
<div class="block">Cause the data to not be de-compressed, even if the <a href="../../../framework/CuratorFramework.html" title="interface in org.apache.curator.framework"><code>CuratorFramework</code></a>
has compressionEnabled</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>this</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="storingStatIn(org.apache.zookeeper.data.Stat)">
<h3>storingStatIn</h3>
<div class="member-signature"><span class="return-type"><a href="AsyncPathable.html" title="interface in org.apache.curator.x.async.api">AsyncPathable</a>&lt;<a href="../AsyncStage.html" title="interface in org.apache.curator.x.async">AsyncStage</a>&lt;byte[]&gt;&gt;</span>&nbsp;<span class="element-name">storingStatIn</span><wbr><span class="parameters">(org.apache.zookeeper.data.Stat&nbsp;stat)</span></div>
<div class="block">Have the operation fill the provided stat object</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>stat</code> - the stat to have filled in</dd>
<dt>Returns:</dt>
<dd>this</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="decompressedStoringStatIn(org.apache.zookeeper.data.Stat)">
<h3>decompressedStoringStatIn</h3>
<div class="member-signature"><span class="return-type"><a href="AsyncPathable.html" title="interface in org.apache.curator.x.async.api">AsyncPathable</a>&lt;<a href="../AsyncStage.html" title="interface in org.apache.curator.x.async">AsyncStage</a>&lt;byte[]&gt;&gt;</span>&nbsp;<span class="element-name">decompressedStoringStatIn</span><wbr><span class="parameters">(org.apache.zookeeper.data.Stat&nbsp;stat)</span></div>
<div class="block">Have the operation fill the provided stat object and have the data be de-compressed</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>stat</code> - the stat to have filled in</dd>
<dt>Returns:</dt>
<dd>this</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="#decompressed()"><code>decompressed()</code></a></li>
<li><a href="#storingStatIn(org.apache.zookeeper.data.Stat)"><code>storingStatIn(org.apache.zookeeper.data.Stat)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="undecompressedStoringStatIn(org.apache.zookeeper.data.Stat)">
<h3>undecompressedStoringStatIn</h3>
<div class="member-signature"><span class="return-type"><a href="AsyncPathable.html" title="interface in org.apache.curator.x.async.api">AsyncPathable</a>&lt;<a href="../AsyncStage.html" title="interface in org.apache.curator.x.async">AsyncStage</a>&lt;byte[]&gt;&gt;</span>&nbsp;<span class="element-name">undecompressedStoringStatIn</span><wbr><span class="parameters">(org.apache.zookeeper.data.Stat&nbsp;stat)</span></div>
<div class="block">Have the operation fill the provided stat object without the data being de-compressed</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>stat</code> - the stat to have filled in</dd>
<dt>Returns:</dt>
<dd>this</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="#undecompressed()"><code>undecompressed()</code></a></li>
<li><a href="#storingStatIn(org.apache.zookeeper.data.Stat)"><code>storingStatIn(org.apache.zookeeper.data.Stat)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2011&#x2013;2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>