Google Git
Sign in
apache / geode-site / asf-site / . / releases / latest / javadoc / org / apache / geode / services / result / impl / Success.html
blob: 8c1df78399a61bf8f2c0b44dff60a4e0ba6619b5 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Success (Apache Geode 1.15.1)</title>
<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="Success (Apache Geode 1.15.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<li><a href="../../../../../../org/apache/geode/services/result/impl/Failure.html" title="class in org.apache.geode.services.result.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/geode/services/result/impl/Success.html" target="_top">Frames</a></li>
<li><a href="Success.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.geode.services.result.impl</div>
<h2 title="Class Success" class="title">Class Success&lt;SuccessType&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.geode.services.result.impl.Success&lt;SuccessType&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>SuccessType</code> - the result type for a successful operation.</dd>
</dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/apache/geode/services/result/Result.html" title="interface in org.apache.geode.services.result">Result</a>&lt;SuccessType,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;, <a href="../../../../../../org/apache/geode/services/result/ServiceResult.html" title="interface in org.apache.geode.services.result">ServiceResult</a>&lt;SuccessType&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Success&lt;SuccessType&gt;</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../../org/apache/geode/services/result/ServiceResult.html" title="interface in org.apache.geode.services.result">ServiceResult</a>&lt;SuccessType&gt;</pre>
<div class="block">This type of <a href="../../../../../../org/apache/geode/services/result/ServiceResult.html" title="interface in org.apache.geode.services.result"><code>ServiceResult</code></a> represents a successful operation. It contains the
return value of type <code>SuccessType</code></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.14.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/geode/services/result/ServiceResult.html" title="interface in org.apache.geode.services.result"><code>ServiceResult</code></a>,
<a href="../../../../../../org/apache/geode/services/result/impl/Failure.html" title="class in org.apache.geode.services.result.impl"><code>Failure</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="class in org.apache.geode.services.result.impl">Success</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/services/result/impl/Success.html#SUCCESS_TRUE">SUCCESS_TRUE</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/services/result/impl/Success.html#getErrorMessage--">getErrorMessage</a></span>()</code>
<div class="block">The return message of a failed operation.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="type parameter in Success">SuccessType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/services/result/impl/Success.html#getMessage--">getMessage</a></span>()</code>
<div class="block">The return message of a successful operation.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/geode/services/result/ServiceResult.html" title="interface in org.apache.geode.services.result">ServiceResult</a>&lt;<a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="type parameter in Success">SuccessType</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/services/result/impl/Success.html#ifSuccessful-java.util.function.Consumer-">ifSuccessful</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a>&lt;? super <a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="type parameter in Success">SuccessType</a>&gt;&nbsp;consumer)</code>
<div class="block">Executes the provided <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function"><code>Consumer</code></a> if this <a href="../../../../../../org/apache/geode/services/result/ServiceResult.html" title="interface in org.apache.geode.services.result"><code>ServiceResult</code></a> is a success.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/services/result/impl/Success.html#isSuccessful--">isSuccessful</a></span>()</code>
<div class="block">Returns a boolean to indicate the success or failure of the operation</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/services/result/impl/Success.html#map-java.util.function.Function-java.util.function.Function-">map</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function">Function</a>&lt;<a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="type parameter in Success">SuccessType</a>,T&gt;&nbsp;successFunction,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function">Function</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,T&gt;&nbsp;errorFunction)</code>
<div class="block">A mapping function that maps to either <code>SuccessType</code> or <code>FailureType</code> depending on
success or
failure of the operation.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="class in org.apache.geode.services.result.impl">Success</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/services/result/impl/Success.html#of-T-">of</a></span>(T&nbsp;result)</code>
<div class="block">Creates a <a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="class in org.apache.geode.services.result.impl"><code>Success</code></a> object containing the errorMessage</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.services.result.ServiceResult">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.geode.services.result.<a href="../../../../../../org/apache/geode/services/result/ServiceResult.html" title="interface in org.apache.geode.services.result">ServiceResult</a></h3>
<code><a href="../../../../../../org/apache/geode/services/result/ServiceResult.html#ifFailure-java.util.function.Consumer-">ifFailure</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.services.result.Result">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.geode.services.result.<a href="../../../../../../org/apache/geode/services/result/Result.html" title="interface in org.apache.geode.services.result">Result</a></h3>
<code><a href="../../../../../../org/apache/geode/services/result/Result.html#isFailure--">isFailure</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="SUCCESS_TRUE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SUCCESS_TRUE</h4>
<pre><a href="../../../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a>
public static final&nbsp;<a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="class in org.apache.geode.services.result.impl">Success</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&gt; SUCCESS_TRUE</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="of-java.lang.Object-">
<!-- -->
</a><a name="of-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;<a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="class in org.apache.geode.services.result.impl">Success</a>&lt;T&gt;&nbsp;of(T&nbsp;result)</pre>
<div class="block">Creates a <a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="class in org.apache.geode.services.result.impl"><code>Success</code></a> object containing the errorMessage</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the type of the result</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>result</code> - the return value of the successful operation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="class in org.apache.geode.services.result.impl"><code>Success</code></a> instance containing the return value</dd>
</dl>
</li>
</ul>
<a name="map-java.util.function.Function-java.util.function.Function-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>map</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;T&nbsp;map(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function">Function</a>&lt;<a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="type parameter in Success">SuccessType</a>,T&gt;&nbsp;successFunction,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function">Function</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,T&gt;&nbsp;errorFunction)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/geode/services/result/Result.html#map-java.util.function.Function-java.util.function.Function-">Result</a></code></span></div>
<div class="block">A mapping function that maps to either <code>SuccessType</code> or <code>FailureType</code> depending on
success or
failure of the operation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/geode/services/result/Result.html#map-java.util.function.Function-java.util.function.Function-">map</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/geode/services/result/Result.html" title="interface in org.apache.geode.services.result">Result</a>&lt;<a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="type parameter in Success">SuccessType</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/geode/services/result/ServiceResult.html#map-java.util.function.Function-java.util.function.Function-">map</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/geode/services/result/ServiceResult.html" title="interface in org.apache.geode.services.result">ServiceResult</a>&lt;<a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="type parameter in Success">SuccessType</a>&gt;</code></dd>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the resultant type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>successFunction</code> - the mapping function to map the SuccessType to the resultant type</dd>
<dd><code>errorFunction</code> - the mapping function to map the FailureType to the resultant error type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>result of type <code>T</code></dd>
</dl>
</li>
</ul>
<a name="getMessage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessage</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="type parameter in Success">SuccessType</a>&nbsp;getMessage()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/geode/services/result/Result.html#getMessage--">Result</a></code></span></div>
<div class="block">The return message of a successful operation. The return type is of type <code>SuccessType</code></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/geode/services/result/Result.html#getMessage--">getMessage</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/geode/services/result/Result.html" title="interface in org.apache.geode.services.result">Result</a>&lt;<a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="type parameter in Success">SuccessType</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/geode/services/result/ServiceResult.html#getMessage--">getMessage</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/geode/services/result/ServiceResult.html" title="interface in org.apache.geode.services.result">ServiceResult</a>&lt;<a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="type parameter in Success">SuccessType</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the result of the operation</dd>
</dl>
</li>
</ul>
<a name="getErrorMessage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorMessage</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getErrorMessage()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/geode/services/result/Result.html#getErrorMessage--">Result</a></code></span></div>
<div class="block">The return message of a failed operation. The return type is of type <code>FailureType</code></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/geode/services/result/Result.html#getErrorMessage--">getErrorMessage</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/geode/services/result/Result.html" title="interface in org.apache.geode.services.result">Result</a>&lt;<a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="type parameter in Success">SuccessType</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/geode/services/result/ServiceResult.html#getErrorMessage--">getErrorMessage</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/geode/services/result/ServiceResult.html" title="interface in org.apache.geode.services.result">ServiceResult</a>&lt;<a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="type parameter in Success">SuccessType</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the failure message of why the operation did not succeed.</dd>
</dl>
</li>
</ul>
<a name="isSuccessful--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSuccessful</h4>
<pre>public&nbsp;boolean&nbsp;isSuccessful()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/geode/services/result/Result.html#isSuccessful--">Result</a></code></span></div>
<div class="block">Returns a boolean to indicate the success or failure of the operation</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/geode/services/result/Result.html#isSuccessful--">isSuccessful</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/geode/services/result/Result.html" title="interface in org.apache.geode.services.result">Result</a>&lt;<a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="type parameter in Success">SuccessType</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true indicating the success of the operation</dd>
</dl>
</li>
</ul>
<a name="ifSuccessful-java.util.function.Consumer-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ifSuccessful</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/geode/services/result/ServiceResult.html" title="interface in org.apache.geode.services.result">ServiceResult</a>&lt;<a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="type parameter in Success">SuccessType</a>&gt;&nbsp;ifSuccessful(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a>&lt;? super <a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="type parameter in Success">SuccessType</a>&gt;&nbsp;consumer)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/geode/services/result/ServiceResult.html#ifSuccessful-java.util.function.Consumer-">ServiceResult</a></code></span></div>
<div class="block">Executes the provided <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function"><code>Consumer</code></a> if this <a href="../../../../../../org/apache/geode/services/result/ServiceResult.html" title="interface in org.apache.geode.services.result"><code>ServiceResult</code></a> is a success.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/geode/services/result/ServiceResult.html#ifSuccessful-java.util.function.Consumer-">ifSuccessful</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/geode/services/result/ServiceResult.html" title="interface in org.apache.geode.services.result">ServiceResult</a>&lt;<a href="../../../../../../org/apache/geode/services/result/impl/Success.html" title="type parameter in Success">SuccessType</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>consumer</code> - the <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function"><code>Consumer</code></a> to be executed on success.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="../../../../../../org/apache/geode/services/result/ServiceResult.html" title="interface in org.apache.geode.services.result"><code>ServiceResult</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<li><a href="../../../../../../org/apache/geode/services/result/impl/Failure.html" title="class in org.apache.geode.services.result.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/geode/services/result/impl/Success.html" target="_top">Frames</a></li>
<li><a href="Success.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>