mirror of https://github.com/dapr/java-sdk.git
356 lines
15 KiB
HTML
356 lines
15 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (13.0.2) on Tue Jun 09 14:27:52 PDT 2020 -->
|
|
<title>ActorStateManager (dapr-sdk-parent 0.6.0 API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<meta name="dc.created" content="2020-06-09">
|
|
<meta name="description" content="declaration: package: io.dapr.actors.runtime, class: ActorStateManager">
|
|
<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.css" title="Style">
|
|
<script type="text/javascript" src="../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
|
|
<!--[if IE]>
|
|
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
<![endif]-->
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script>
|
|
</head>
|
|
<body class="class-declaration">
|
|
<script type="text/javascript">var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
var pathtoroot = "../../../../";
|
|
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/ActorStateManager.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">
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="navListSearch"><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<a id="skip.navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<!-- ========= 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">io.dapr.actors.runtime</a></div>
|
|
<h1 title="Class ActorStateManager" class="title">Class ActorStateManager</h1>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="inheritance" title="Inheritance Tree">java.lang.Object
|
|
<div class="inheritance">io.dapr.actors.runtime.ActorStateManager</div>
|
|
</div>
|
|
<section class="description">
|
|
<hr>
|
|
<pre>public class <span class="typeNameLabel">ActorStateManager</span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block">Manages state changes of a given Actor instance.
|
|
All changes are cached in-memory until save() is called.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="blockList">
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li class="blockList">
|
|
<section class="methodSummary"><a id="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Method Summary</h2>
|
|
<div class="memberSummary">
|
|
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
|
|
<div id="memberSummary_tabpanel" role="tabpanel">
|
|
<table aria-labelledby="t0">
|
|
<thead>
|
|
<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>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="altColor" id="i0">
|
|
<td class="colFirst"><code><T> reactor.core.publisher.Mono<java.lang.Void></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.lang.String,T)">add</a></span>​(java.lang.String stateName,
|
|
T value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Adds a given key/value to the Actor's state store's cache.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i1">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Clears all changes not yet saved to state store.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor" id="i2">
|
|
<td class="colFirst"><code>reactor.core.publisher.Mono<java.lang.Boolean></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contains(java.lang.String)">contains</a></span>​(java.lang.String stateName)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Checks if a given state exists in state store or cache.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i3">
|
|
<td class="colFirst"><code><T> reactor.core.publisher.Mono<T></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(java.lang.String,java.lang.Class)">get</a></span>​(java.lang.String stateName,
|
|
java.lang.Class<T> clazz)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Fetches the most recent value for the given state, including cached value.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor" id="i4">
|
|
<td class="colFirst"><code>reactor.core.publisher.Mono<java.lang.Void></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remove(java.lang.String)">remove</a></span>​(java.lang.String stateName)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Removes a given state from state store's cache.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i5">
|
|
<td class="colFirst"><code>reactor.core.publisher.Mono<java.lang.Void></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#save()">save</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Saves all changes to state store.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor" id="i6">
|
|
<td class="colFirst"><code><T> reactor.core.publisher.Mono<java.lang.Void></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#set(java.lang.String,T)">set</a></span>​(java.lang.String stateName,
|
|
T value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Updates a given key/value pair in the state store's cache.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="inheritedList">
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<a id="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a><code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="blockList">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li class="blockList">
|
|
<section class="methodDetails"><a id="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Method Details</h2>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="add(java.lang.String,java.lang.Object)">
|
|
<!-- -->
|
|
</a><a id="add(java.lang.String,T)">add</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="typeParameters"><T></span>
|
|
<span class="returnType">reactor.core.publisher.Mono<java.lang.Void></span> <span class="memberName">add</span>​(<span class="arguments">java.lang.String stateName,
|
|
T value)</span></div>
|
|
<div class="block">Adds a given key/value to the Actor's state store's cache.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Type Parameters:</span></dt>
|
|
<dd><code>T</code> - Type of the object being added.</dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>stateName</code> - Name of the state being added.</dd>
|
|
<dd><code>value</code> - Value to be added.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Asynchronous void operation.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="get(java.lang.String,java.lang.Class)">get</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="typeParameters"><T></span> <span class="returnType">reactor.core.publisher.Mono<T></span> <span class="memberName">get</span>​(<span class="arguments">java.lang.String stateName,
|
|
java.lang.Class<T> clazz)</span></div>
|
|
<div class="block">Fetches the most recent value for the given state, including cached value.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Type Parameters:</span></dt>
|
|
<dd><code>T</code> - Type being fetched.</dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>stateName</code> - Name of the state.</dd>
|
|
<dd><code>clazz</code> - Class type for the value being fetched.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Asynchronous response with fetched object.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="set(java.lang.String,java.lang.Object)">
|
|
<!-- -->
|
|
</a><a id="set(java.lang.String,T)">set</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="typeParameters"><T></span>
|
|
<span class="returnType">reactor.core.publisher.Mono<java.lang.Void></span> <span class="memberName">set</span>​(<span class="arguments">java.lang.String stateName,
|
|
T value)</span></div>
|
|
<div class="block">Updates a given key/value pair in the state store's cache.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Type Parameters:</span></dt>
|
|
<dd><code>T</code> - Type of the value being set.</dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>stateName</code> - Name of the state being updated.</dd>
|
|
<dd><code>value</code> - Value to be set for given state.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Asynchronous void result.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="remove(java.lang.String)">remove</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">reactor.core.publisher.Mono<java.lang.Void></span> <span class="memberName">remove</span>​(<span class="arguments">java.lang.String stateName)</span></div>
|
|
<div class="block">Removes a given state from state store's cache.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>stateName</code> - State being stored.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Asynchronous void result.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="contains(java.lang.String)">contains</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">reactor.core.publisher.Mono<java.lang.Boolean></span> <span class="memberName">contains</span>​(<span class="arguments">java.lang.String stateName)</span></div>
|
|
<div class="block">Checks if a given state exists in state store or cache.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>stateName</code> - State being checked.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Asynchronous boolean result indicating whether state is present.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="save()">save</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">reactor.core.publisher.Mono<java.lang.Void></span> <span class="memberName">save</span>()</div>
|
|
<div class="block">Saves all changes to state store.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Asynchronous void result.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="clear()">clear</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">clear</span>()</div>
|
|
<div class="block">Clears all changes not yet saved to state store.</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</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/ActorStateManager.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">
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
<p class="legalCopy"><small>Copyright © 2020. All rights reserved.</small></p>
|
|
</footer>
|
|
</body>
|
|
</html>
|