| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>InboundSseEvent</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="InboundSseEvent"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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"; |
| </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>Prev Class</li> |
| <li><a href="../../../../javax/ws/rs/sse/OutboundSseEvent.html" title="interface in javax.ws.rs.sse"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/ws/rs/sse/InboundSseEvent.html" target="_top">Frames</a></li> |
| <li><a href="InboundSseEvent.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">javax.ws.rs.sse</div> |
| <h2 title="Interface InboundSseEvent" class="title">Interface InboundSseEvent</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../javax/ws/rs/sse/SseEvent.html" title="interface in javax.ws.rs.sse">SseEvent</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">InboundSseEvent</span> |
| extends <a href="../../../../javax/ws/rs/sse/SseEvent.html" title="interface in javax.ws.rs.sse">SseEvent</a></pre> |
| <div class="block">Inbound Server-sent event. |
| <p> |
| Used on the client side, when accepting incoming Server-sent events.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.javax.ws.rs.sse.SseEvent"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface javax.ws.rs.sse.<a href="../../../../javax/ws/rs/sse/SseEvent.html" title="interface in javax.ws.rs.sse">SseEvent</a></h3> |
| <code><a href="../../../../javax/ws/rs/sse/SseEvent.html#RECONNECT_NOT_SET">RECONNECT_NOT_SET</a></code></li> |
| </ul> |
| </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/sse/InboundSseEvent.html#isEmpty--">isEmpty</a></span>()</code> |
| <div class="block">Check if the event is empty (i.e.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/sse/InboundSseEvent.html#readData--">readData</a></span>()</code> |
| <div class="block">Get the original event data as <code>String</code>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/sse/InboundSseEvent.html#readData-java.lang.Class-">readData</a></span>(java.lang.Class<T> type)</code> |
| <div class="block">Read event data as a given Java type.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/sse/InboundSseEvent.html#readData-java.lang.Class-javax.ws.rs.core.MediaType-">readData</a></span>(java.lang.Class<T> messageType, |
| <a href="../../../../javax/ws/rs/core/MediaType.html" title="class in javax.ws.rs.core">MediaType</a> mediaType)</code> |
| <div class="block">Read event data as a given Java type.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/sse/InboundSseEvent.html#readData-javax.ws.rs.core.GenericType-">readData</a></span>(<a href="../../../../javax/ws/rs/core/GenericType.html" title="class in javax.ws.rs.core">GenericType</a><T> type)</code> |
| <div class="block">Read event data as a given generic type.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/sse/InboundSseEvent.html#readData-javax.ws.rs.core.GenericType-javax.ws.rs.core.MediaType-">readData</a></span>(<a href="../../../../javax/ws/rs/core/GenericType.html" title="class in javax.ws.rs.core">GenericType</a><T> type, |
| <a href="../../../../javax/ws/rs/core/MediaType.html" title="class in javax.ws.rs.core">MediaType</a> mediaType)</code> |
| <div class="block">Read event data as a given generic type.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.javax.ws.rs.sse.SseEvent"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface javax.ws.rs.sse.<a href="../../../../javax/ws/rs/sse/SseEvent.html" title="interface in javax.ws.rs.sse">SseEvent</a></h3> |
| <code><a href="../../../../javax/ws/rs/sse/SseEvent.html#getComment--">getComment</a>, <a href="../../../../javax/ws/rs/sse/SseEvent.html#getId--">getId</a>, <a href="../../../../javax/ws/rs/sse/SseEvent.html#getName--">getName</a>, <a href="../../../../javax/ws/rs/sse/SseEvent.html#getReconnectDelay--">getReconnectDelay</a>, <a href="../../../../javax/ws/rs/sse/SseEvent.html#isReconnectDelaySet--">isReconnectDelaySet</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="isEmpty--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEmpty</h4> |
| <pre>boolean isEmpty()</pre> |
| <div class="block">Check if the event is empty (i.e. does not contain any data).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if current instance does not contain any data, <code>false</code> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readData--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readData</h4> |
| <pre>java.lang.String readData()</pre> |
| <div class="block">Get the original event data as <code>String</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>event data de-serialized into a string.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/ws/rs/ProcessingException.html" title="class in javax.ws.rs">ProcessingException</a></code> - when provided type can't be read. The thrown exception wraps the original cause.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readData-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readData</h4> |
| <pre><T> T readData(java.lang.Class<T> type)</pre> |
| <div class="block">Read event data as a given Java type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - Java type to be used for event data de-serialization.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>event data de-serialized as an instance of a given type.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/ws/rs/ProcessingException.html" title="class in javax.ws.rs">ProcessingException</a></code> - when provided type can't be read. The thrown exception wraps the original cause.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readData-javax.ws.rs.core.GenericType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readData</h4> |
| <pre><T> T readData(<a href="../../../../javax/ws/rs/core/GenericType.html" title="class in javax.ws.rs.core">GenericType</a><T> type)</pre> |
| <div class="block">Read event data as a given generic type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - generic type to be used for event data de-serialization.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>event data de-serialized as an instance of a given type.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/ws/rs/ProcessingException.html" title="class in javax.ws.rs">ProcessingException</a></code> - when provided type can't be read. The thrown exception wraps the original cause.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readData-java.lang.Class-javax.ws.rs.core.MediaType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readData</h4> |
| <pre><T> T readData(java.lang.Class<T> messageType, |
| <a href="../../../../javax/ws/rs/core/MediaType.html" title="class in javax.ws.rs.core">MediaType</a> mediaType)</pre> |
| <div class="block">Read event data as a given Java type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>messageType</code> - Java type to be used for event data de-serialization.</dd> |
| <dd><code>mediaType</code> - <a href="../../../../javax/ws/rs/core/MediaType.html" title="class in javax.ws.rs.core"><code>media type</code></a> to be used for event data de-serialization.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>event data de-serialized as an instance of a given type.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/ws/rs/ProcessingException.html" title="class in javax.ws.rs">ProcessingException</a></code> - when provided type can't be read. The thrown exception wraps the original cause.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readData-javax.ws.rs.core.GenericType-javax.ws.rs.core.MediaType-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>readData</h4> |
| <pre><T> T readData(<a href="../../../../javax/ws/rs/core/GenericType.html" title="class in javax.ws.rs.core">GenericType</a><T> type, |
| <a href="../../../../javax/ws/rs/core/MediaType.html" title="class in javax.ws.rs.core">MediaType</a> mediaType)</pre> |
| <div class="block">Read event data as a given generic type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - generic type to be used for event data de-serialization.</dd> |
| <dd><code>mediaType</code> - <a href="../../../../javax/ws/rs/core/MediaType.html" title="class in javax.ws.rs.core"><code>media type</code></a> to be used for event data de-serialization.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>event data de-serialized as an instance of a given type.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/ws/rs/ProcessingException.html" title="class in javax.ws.rs">ProcessingException</a></code> - when provided type can't be read. The thrown exception wraps the original cause.</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>Prev Class</li> |
| <li><a href="../../../../javax/ws/rs/sse/OutboundSseEvent.html" title="interface in javax.ws.rs.sse"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/ws/rs/sse/InboundSseEvent.html" target="_top">Frames</a></li> |
| <li><a href="InboundSseEvent.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
