Files
redkale/javadoc/org/redkale/service/RetResult.html
wentch 5d2c3e50ba
2016-01-21 14:00:42 +08:00

542 lines
20 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="zh">
<head>
<!-- Generated by javadoc (1.8.0_65) on Thu Jan 21 13:52:16 CST 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RetResult (RedKale的API文档)</title>
<meta name="date" content="2016-01-21">
<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="RetResult (RedKale\u7684API\u6587\u6863)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","所有方法"],2:["t2","实例方法"],8:["t4","具体方法"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>您的浏览器已禁用 JavaScript。</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="跳过导航链接">跳过导航链接</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="导航">
<li><a href="../../../overview-summary.html">概览</a></li>
<li><a href="package-summary.html">程序包</a></li>
<li class="navBarCell1Rev"></li>
<li><a href="class-use/RetResult.html">使用</a></li>
<li><a href="package-tree.html"></a></li>
<li><a href="../../../deprecated-list.html">已过时</a></li>
<li><a href="../../../index-files/index-1.html">索引</a></li>
<li><a href="../../../help-doc.html">帮助</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/redkale/service/MultiRun.html" title="org.redkale.service中的注释"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../org/redkale/service/RetResult.RetSuccessResult.html" title="org.redkale.service中的类"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/redkale/service/RetResult.html" target="_top">框架</a></li>
<li><a href="RetResult.html" target="_top">无框架</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">所有类</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>概要:&nbsp;</li>
<li><a href="#nested.class.summary">嵌套</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">字段</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">构造器</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li><a href="#field.detail">字段</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">构造器</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">方法</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.redkale.service</div>
<h2 title="类 RetResult" class="title">类 RetResult&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.redkale.service.RetResult&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">类型参数:</span></dt>
<dd><code>T</code> - 结果对象的泛型</dd>
</dl>
<dl>
<dt>直接已知子类:</dt>
<dd><a href="../../../org/redkale/service/RetResult.RetSuccessResult.html" title="org.redkale.service中的类">RetResult.RetSuccessResult</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">RetResult&lt;T&gt;</span>
extends java.lang.Object</pre>
<div class="block">通用的结果对象在常见的HTTP+JSON接口中返回的结果需要含结果码错误信息和实体对象。
<p>
详情见: http://www.redkale.org</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>嵌套类概要</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="嵌套类概要表, 列表嵌套类和解释">
<caption><span>嵌套类</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">限定符和类型</th>
<th class="colLast" scope="col">类和说明</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/redkale/service/RetResult.RetSuccessResult.html" title="org.redkale.service中的类">RetResult.RetSuccessResult</a>&lt;<a href="../../../org/redkale/service/RetResult.RetSuccessResult.html" title="RetResult.RetSuccessResult中的类型参数">T</a>&gt;</span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>字段概要</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="字段概要表, 列表字段和解释">
<caption><span>字段</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">限定符和类型</th>
<th class="colLast" scope="col">字段和说明</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/redkale/service/RetResult.html#retcode">retcode</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/redkale/service/RetResult.html#retinfo">retinfo</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/redkale/service/RetResult.html" title="org.redkale.service中的类">RetResult</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/redkale/service/RetResult.html#SUCCESS">SUCCESS</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>构造器概要</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="构造器概要表, 列表构造器和解释">
<caption><span>构造器</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">构造器和说明</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/redkale/service/RetResult.html#RetResult--">RetResult</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/redkale/service/RetResult.html#RetResult-int-">RetResult</a></span>(int&nbsp;retcode)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/redkale/service/RetResult.html#RetResult-int-java.lang.String-">RetResult</a></span>(int&nbsp;retcode,
java.lang.String&nbsp;retinfo)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/redkale/service/RetResult.html#RetResult-int-java.lang.String-T-">RetResult</a></span>(int&nbsp;retcode,
java.lang.String&nbsp;retinfo,
<a href="../../../org/redkale/service/RetResult.html" title="RetResult中的类型参数">T</a>&nbsp;result)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/redkale/service/RetResult.html#RetResult-T-">RetResult</a></span>(<a href="../../../org/redkale/service/RetResult.html" title="RetResult中的类型参数">T</a>&nbsp;result)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>方法概要</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="方法概要表, 列表方法和解释">
<caption><span id="t0" class="activeTableTab"><span>所有方法</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">实例方法</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">具体方法</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">限定符和类型</th>
<th class="colLast" scope="col">方法和说明</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../org/redkale/service/RetResult.html" title="RetResult中的类型参数">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/redkale/service/RetResult.html#getResult--">getResult</a></span>()</code>
<div class="block">结果对象, 通常只有在retcode = 0时值才有效</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/redkale/service/RetResult.html#getRetcode--">getRetcode</a></span>()</code>
<div class="block">结果码 0表示成功、 非0表示错误</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/redkale/service/RetResult.html#getRetinfo--">getRetinfo</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/redkale/service/RetResult.html#isSuccess--">isSuccess</a></span>()</code>
<div class="block">判断结果是否成功返回, retcode = 0 视为成功, 否则视为错误码</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/redkale/service/RetResult.html#setResult-T-">setResult</a></span>(<a href="../../../org/redkale/service/RetResult.html" title="RetResult中的类型参数">T</a>&nbsp;result)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/redkale/service/RetResult.html#setRetcode-int-">setRetcode</a></span>(int&nbsp;retcode)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/redkale/service/RetResult.html#setRetinfo-java.lang.String-">setRetinfo</a></span>(java.lang.String&nbsp;retinfo)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/redkale/service/RetResult.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>从类继承的方法&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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>字段详细资料</h3>
<a name="SUCCESS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SUCCESS</h4>
<pre>public static final&nbsp;<a href="../../../org/redkale/service/RetResult.html" title="org.redkale.service中的类">RetResult</a> SUCCESS</pre>
</li>
</ul>
<a name="retcode">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retcode</h4>
<pre>protected&nbsp;int retcode</pre>
</li>
</ul>
<a name="retinfo">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>retinfo</h4>
<pre>protected&nbsp;java.lang.String retinfo</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>构造器详细资料</h3>
<a name="RetResult--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RetResult</h4>
<pre>public&nbsp;RetResult()</pre>
</li>
</ul>
<a name="RetResult-java.lang.Object-">
<!-- -->
</a><a name="RetResult-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RetResult</h4>
<pre>public&nbsp;RetResult(<a href="../../../org/redkale/service/RetResult.html" title="RetResult中的类型参数">T</a>&nbsp;result)</pre>
</li>
</ul>
<a name="RetResult-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RetResult</h4>
<pre>public&nbsp;RetResult(int&nbsp;retcode)</pre>
</li>
</ul>
<a name="RetResult-int-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RetResult</h4>
<pre>public&nbsp;RetResult(int&nbsp;retcode,
java.lang.String&nbsp;retinfo)</pre>
</li>
</ul>
<a name="RetResult-int-java.lang.String-java.lang.Object-">
<!-- -->
</a><a name="RetResult-int-java.lang.String-T-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RetResult</h4>
<pre>public&nbsp;RetResult(int&nbsp;retcode,
java.lang.String&nbsp;retinfo,
<a href="../../../org/redkale/service/RetResult.html" title="RetResult中的类型参数">T</a>&nbsp;result)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>方法详细资料</h3>
<a name="isSuccess--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSuccess</h4>
<pre>public&nbsp;boolean&nbsp;isSuccess()</pre>
<div class="block">判断结果是否成功返回, retcode = 0 视为成功, 否则视为错误码</div>
<dl>
<dt><span class="returnLabel">返回:</span></dt>
<dd>是否成功</dd>
</dl>
</li>
</ul>
<a name="getRetcode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRetcode</h4>
<pre>public&nbsp;int&nbsp;getRetcode()</pre>
<div class="block">结果码 0表示成功、 非0表示错误</div>
<dl>
<dt><span class="returnLabel">返回:</span></dt>
<dd>结果码</dd>
</dl>
</li>
</ul>
<a name="setRetcode-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRetcode</h4>
<pre>public&nbsp;void&nbsp;setRetcode(int&nbsp;retcode)</pre>
</li>
</ul>
<a name="getRetinfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRetinfo</h4>
<pre>public&nbsp;java.lang.String&nbsp;getRetinfo()</pre>
</li>
</ul>
<a name="setRetinfo-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRetinfo</h4>
<pre>public&nbsp;void&nbsp;setRetinfo(java.lang.String&nbsp;retinfo)</pre>
</li>
</ul>
<a name="getResult--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResult</h4>
<pre>public&nbsp;<a href="../../../org/redkale/service/RetResult.html" title="RetResult中的类型参数">T</a>&nbsp;getResult()</pre>
<div class="block">结果对象, 通常只有在retcode = 0时值才有效</div>
<dl>
<dt><span class="returnLabel">返回:</span></dt>
<dd>结果对象</dd>
</dl>
</li>
</ul>
<a name="setResult-java.lang.Object-">
<!-- -->
</a><a name="setResult-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setResult</h4>
<pre>public&nbsp;void&nbsp;setResult(<a href="../../../org/redkale/service/RetResult.html" title="RetResult中的类型参数">T</a>&nbsp;result)</pre>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">覆盖:</span></dt>
<dd><code>toString</code>&nbsp;在类中&nbsp;<code>java.lang.Object</code></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="跳过导航链接">跳过导航链接</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="导航">
<li><a href="../../../overview-summary.html">概览</a></li>
<li><a href="package-summary.html">程序包</a></li>
<li class="navBarCell1Rev"></li>
<li><a href="class-use/RetResult.html">使用</a></li>
<li><a href="package-tree.html"></a></li>
<li><a href="../../../deprecated-list.html">已过时</a></li>
<li><a href="../../../index-files/index-1.html">索引</a></li>
<li><a href="../../../help-doc.html">帮助</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/redkale/service/MultiRun.html" title="org.redkale.service中的注释"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../org/redkale/service/RetResult.RetSuccessResult.html" title="org.redkale.service中的类"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/redkale/service/RetResult.html" target="_top">框架</a></li>
<li><a href="RetResult.html" target="_top">无框架</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">所有类</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>概要:&nbsp;</li>
<li><a href="#nested.class.summary">嵌套</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">字段</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">构造器</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li><a href="#field.detail">字段</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">构造器</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">方法</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>