Google Git
Sign in
eclipse / www.eclipse.org / jetty / caa63cef1178e162a958a0ce982848d67ac0e16a / . / javadoc / jetty-9 / org / eclipse / jetty / websocket / jsr356 / annotations / JsrCallable.html
blob: 06c961c62c060ebd28b3b1693afe2c86ad1d76a9 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Fri Feb 26 09:50:23 CST 2021 -->
<title>JsrCallable (Jetty :: Project 9.4.38.v20210224 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-02-26">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JsrCallable (Jetty :: Project 9.4.38.v20210224 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = false;
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/JsrCallable.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">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.eclipse.jetty.websocket.jsr356.annotations</a></div>
<h2 title="Class JsrCallable" class="title">Class JsrCallable</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../common/events/annotated/CallableMethod.html" title="class in org.eclipse.jetty.websocket.common.events.annotated">org.eclipse.jetty.websocket.common.events.annotated.CallableMethod</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.websocket.jsr356.annotations.JsrCallable</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="OnCloseCallable.html" title="class in org.eclipse.jetty.websocket.jsr356.annotations">OnCloseCallable</a></code>, <code><a href="OnErrorCallable.html" title="class in org.eclipse.jetty.websocket.jsr356.annotations">OnErrorCallable</a></code>, <code><a href="OnMessageCallable.html" title="class in org.eclipse.jetty.websocket.jsr356.annotations">OnMessageCallable</a></code>, <code><a href="OnOpenCallable.html" title="class in org.eclipse.jetty.websocket.jsr356.annotations">OnOpenCallable</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">JsrCallable</span>
extends <a href="../../common/events/annotated/CallableMethod.html" title="class in org.eclipse.jetty.websocket.common.events.annotated">CallableMethod</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.Object[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#args">args</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#idxConfig">idxConfig</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#idxSession">idxSession</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="Param.html" title="class in org.eclipse.jetty.websocket.jsr356.annotations">Param</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#params">params</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.websocket.common.events.annotated.CallableMethod">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.jetty.websocket.common.events.annotated.<a href="../../common/events/annotated/CallableMethod.html" title="class in org.eclipse.jetty.websocket.common.events.annotated">CallableMethod</a></h3>
<code><a href="../../common/events/annotated/CallableMethod.html#method">method</a>, <a href="../../common/events/annotated/CallableMethod.html#paramTypes">paramTypes</a>, <a href="../../common/events/annotated/CallableMethod.html#pojo">pojo</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Class,java.lang.reflect.Method)">JsrCallable</a></span>&#8203;(java.lang.Class&lt;?&gt;&nbsp;pojo,
java.lang.reflect.Method&nbsp;method)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.websocket.jsr356.annotations.JsrCallable)">JsrCallable</a></span>&#8203;(<a href="JsrCallable.html" title="class in org.eclipse.jetty.websocket.jsr356.annotations">JsrCallable</a>&nbsp;copy)</code></th>
<td class="colLast">
<div class="block">Copy Constructor</div>
</td>
</tr>
</table>
</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><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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assertRoleRequired(int,java.lang.String)">assertRoleRequired</a></span>&#8203;(int&nbsp;index,
java.lang.String&nbsp;description)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findIndexForRole(org.eclipse.jetty.websocket.jsr356.annotations.Param.Role)">findIndexForRole</a></span>&#8203;(<a href="Param.Role.html" title="enum in org.eclipse.jetty.websocket.jsr356.annotations">Param.Role</a>&nbsp;role)</code></th>
<td class="colLast">
<div class="block">Search the list of parameters for first one matching the role specified.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="Param.html" title="class in org.eclipse.jetty.websocket.jsr356.annotations">Param</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findParamForRole(org.eclipse.jetty.websocket.jsr356.annotations.Param.Role)">findParamForRole</a></span>&#8203;(<a href="Param.Role.html" title="enum in org.eclipse.jetty.websocket.jsr356.annotations">Param.Role</a>&nbsp;role)</code></th>
<td class="colLast">
<div class="block">Find first param for specified role.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="Param.html" title="class in org.eclipse.jetty.websocket.jsr356.annotations">Param</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParams()">getParams</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#init(org.eclipse.jetty.websocket.jsr356.JsrSession)">init</a></span>&#8203;(<a href="../JsrSession.html" title="class in org.eclipse.jetty.websocket.jsr356">JsrSession</a>&nbsp;session)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDecodingType(java.lang.Class)">setDecodingType</a></span>&#8203;(java.lang.Class&lt;?&gt;&nbsp;decodingType)</code></th>
<td class="colLast">
<div class="block">The Type of Class a <code>Decoder</code> should be created to produce.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.common.events.annotated.CallableMethod">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.websocket.common.events.annotated.<a href="../../common/events/annotated/CallableMethod.html" title="class in org.eclipse.jetty.websocket.common.events.annotated">CallableMethod</a></h3>
<code><a href="../../common/events/annotated/CallableMethod.html#call(java.lang.Object,java.lang.Object...)">call</a>, <a href="../../common/events/annotated/CallableMethod.html#formatMethodCallError(java.lang.Object...)">formatMethodCallError</a>, <a href="../../common/events/annotated/CallableMethod.html#getMethod()">getMethod</a>, <a href="../../common/events/annotated/CallableMethod.html#getParamTypes()">getParamTypes</a>, <a href="../../common/events/annotated/CallableMethod.html#getPojo()">getPojo</a>, <a href="../../common/events/annotated/CallableMethod.html#toString()">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="params">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>params</h4>
<pre>protected final&nbsp;<a href="Param.html" title="class in org.eclipse.jetty.websocket.jsr356.annotations">Param</a>[] params</pre>
</li>
</ul>
<a id="args">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>args</h4>
<pre>protected final&nbsp;java.lang.Object[] args</pre>
</li>
</ul>
<a id="idxSession">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>idxSession</h4>
<pre>protected&nbsp;int idxSession</pre>
</li>
</ul>
<a id="idxConfig">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>idxConfig</h4>
<pre>protected&nbsp;int idxConfig</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.lang.Class,java.lang.reflect.Method)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JsrCallable</h4>
<pre>public&nbsp;JsrCallable&#8203;(java.lang.Class&lt;?&gt;&nbsp;pojo,
java.lang.reflect.Method&nbsp;method)</pre>
</li>
</ul>
<a id="&lt;init&gt;(org.eclipse.jetty.websocket.jsr356.annotations.JsrCallable)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JsrCallable</h4>
<pre>public&nbsp;JsrCallable&#8203;(<a href="JsrCallable.html" title="class in org.eclipse.jetty.websocket.jsr356.annotations">JsrCallable</a>&nbsp;copy)</pre>
<div class="block">Copy Constructor</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>copy</code> - the JsrCallable to copy from</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="assertRoleRequired(int,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assertRoleRequired</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;assertRoleRequired&#8203;(int&nbsp;index,
java.lang.String&nbsp;description)</pre>
</li>
</ul>
<a id="findIndexForRole(org.eclipse.jetty.websocket.jsr356.annotations.Param.Role)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findIndexForRole</h4>
<pre class="methodSignature">protected&nbsp;int&nbsp;findIndexForRole&#8203;(<a href="Param.Role.html" title="enum in org.eclipse.jetty.websocket.jsr356.annotations">Param.Role</a>&nbsp;role)</pre>
<div class="block">Search the list of parameters for first one matching the role specified.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>role</code> - the role to look for</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the index for the role specified (or -1 if not found)</dd>
</dl>
</li>
</ul>
<a id="findParamForRole(org.eclipse.jetty.websocket.jsr356.annotations.Param.Role)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findParamForRole</h4>
<pre class="methodSignature">protected&nbsp;<a href="Param.html" title="class in org.eclipse.jetty.websocket.jsr356.annotations">Param</a>&nbsp;findParamForRole&#8203;(<a href="Param.Role.html" title="enum in org.eclipse.jetty.websocket.jsr356.annotations">Param.Role</a>&nbsp;role)</pre>
<div class="block">Find first param for specified role.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>role</code> - the role specified</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the param (or null if not found)</dd>
</dl>
</li>
</ul>
<a id="getParams()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParams</h4>
<pre class="methodSignature">public&nbsp;<a href="Param.html" title="class in org.eclipse.jetty.websocket.jsr356.annotations">Param</a>[]&nbsp;getParams()</pre>
</li>
</ul>
<a id="init(org.eclipse.jetty.websocket.jsr356.JsrSession)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;init&#8203;(<a href="../JsrSession.html" title="class in org.eclipse.jetty.websocket.jsr356">JsrSession</a>&nbsp;session)</pre>
</li>
</ul>
<a id="setDecodingType(java.lang.Class)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setDecodingType</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;setDecodingType&#8203;(java.lang.Class&lt;?&gt;&nbsp;decodingType)</pre>
<div class="block">The Type of Class a <code>Decoder</code> should be created to produce.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>decodingType</code> - the type of class a Decoder should be created to produce</dd>
</dl>
</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/JsrCallable.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">
<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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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; 1995&#x2013;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>