blob: 023793584ce63d79c1c081464dc89336ce1f9f0c [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>IJsrMethod (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="IJsrMethod (Jetty :: Project 9.4.38.v20210224 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/IJsrMethod.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>Field&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>Field&nbsp;|&nbsp;</li>
<li>Constr&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="Interface IJsrMethod" class="title">Interface IJsrMethod</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public interface <span class="typeNameLabel">IJsrMethod</span></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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></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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enablePartialMessageSupport()">enablePartialMessageSupport</a></span>()</code></th>
<td class="colLast">
<div class="block">Indicate that partial message support is desired</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFullyQualifiedMethodName()">getFullyQualifiedMethodName</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the fully qualifed method name {classname}.{methodname}({params}) suitable for using in error messages.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.Class&lt;? extends javax.websocket.Decoder&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessageDecoder()">getMessageDecoder</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the Decoder to use for message decoding</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../MessageType.html" title="enum in org.eclipse.jetty.websocket.jsr356">MessageType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessageType()">getMessageType</a></span>()</code></th>
<td class="colLast">
<div class="block">The type of message this method can handle</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.reflect.Method</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMethod()">getMethod</a></span>()</code></th>
<td class="colLast">
<div class="block">The reflected method</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPartialMessageSupportEnabled()">isPartialMessageSupportEnabled</a></span>()</code></th>
<td class="colLast">
<div class="block">Indicator that partial message support is enabled</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMessageDecoder(java.lang.Class)">setMessageDecoder</a></span>&#8203;(java.lang.Class&lt;? extends javax.websocket.Decoder&gt;&nbsp;decoderClass)</code></th>
<td class="colLast">
<div class="block">The message decoder class to use.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMessageType(org.eclipse.jetty.websocket.jsr356.MessageType)">setMessageType</a></span>&#8203;(<a href="../MessageType.html" title="enum in org.eclipse.jetty.websocket.jsr356">MessageType</a>&nbsp;type)</code></th>
<td class="colLast">
<div class="block">The type of message this method can handle</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="enablePartialMessageSupport()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enablePartialMessageSupport</h4>
<pre class="methodSignature">void&nbsp;enablePartialMessageSupport()</pre>
<div class="block">Indicate that partial message support is desired</div>
</li>
</ul>
<a id="getFullyQualifiedMethodName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFullyQualifiedMethodName</h4>
<pre class="methodSignature">java.lang.String&nbsp;getFullyQualifiedMethodName()</pre>
<div class="block">Get the fully qualifed method name {classname}.{methodname}({params}) suitable for using in error messages.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the fully qualified method name for end users</dd>
</dl>
</li>
</ul>
<a id="getMessageDecoder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessageDecoder</h4>
<pre class="methodSignature">java.lang.Class&lt;? extends javax.websocket.Decoder&gt;&nbsp;getMessageDecoder()</pre>
<div class="block">Get the Decoder to use for message decoding</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the decoder class to use for message decoding</dd>
</dl>
</li>
</ul>
<a id="getMessageType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessageType</h4>
<pre class="methodSignature"><a href="../MessageType.html" title="enum in org.eclipse.jetty.websocket.jsr356">MessageType</a>&nbsp;getMessageType()</pre>
<div class="block">The type of message this method can handle</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the message type if &#064;<code>OnMessage</code> annotated, null if unknown/unspecified</dd>
</dl>
</li>
</ul>
<a id="getMethod()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMethod</h4>
<pre class="methodSignature">java.lang.reflect.Method&nbsp;getMethod()</pre>
<div class="block">The reflected method</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the method itself</dd>
</dl>
</li>
</ul>
<a id="isPartialMessageSupportEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPartialMessageSupportEnabled</h4>
<pre class="methodSignature">boolean&nbsp;isPartialMessageSupportEnabled()</pre>
<div class="block">Indicator that partial message support is enabled</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if enabled</dd>
</dl>
</li>
</ul>
<a id="setMessageDecoder(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMessageDecoder</h4>
<pre class="methodSignature">void&nbsp;setMessageDecoder&#8203;(java.lang.Class&lt;? extends javax.websocket.Decoder&gt;&nbsp;decoderClass)</pre>
<div class="block">The message decoder class to use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>decoderClass</code> - the <code>Decoder</code> implementation to use</dd>
</dl>
</li>
</ul>
<a id="setMessageType(org.eclipse.jetty.websocket.jsr356.MessageType)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setMessageType</h4>
<pre class="methodSignature">void&nbsp;setMessageType&#8203;(<a href="../MessageType.html" title="enum in org.eclipse.jetty.websocket.jsr356">MessageType</a>&nbsp;type)</pre>
<div class="block">The type of message this method can handle</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - the type of message</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/IJsrMethod.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>Field&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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>