Google Git
Sign in
gdch-oss / third_party / jakartaee / rest / 447c228d31c08fbe67e7169a7141909de5e09cad / . / apidocs / 3.0.0 / jakarta / ws / rs / sse / OutboundSseEvent.Builder.html
blob: 384974c2914d35a548469040e25e22405d70e03d [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.2) on Wed Sep 23 17:36:24 GMT 2020 -->
<title>OutboundSseEvent.Builder (jakarta.ws.rs-api 3.0.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-09-23">
<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.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.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="OutboundSseEvent.Builder (jakarta.ws.rs-api 3.0.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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 = true;
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/OutboundSseEvent.Builder.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">jakarta.ws.rs.sse</a></div>
<h2 title="Interface OutboundSseEvent.Builder" class="title">Interface OutboundSseEvent.Builder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing interface:</dt>
<dd><a href="OutboundSseEvent.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent</a></dd>
</dl>
<hr>
<pre>public static interface <span class="typeNameLabel">OutboundSseEvent.Builder</span></pre>
<div class="block">A builder class used for creating <a href="OutboundSseEvent.html" title="interface in jakarta.ws.rs.sse"><code>OutboundSseEvent</code></a> instances.</div>
</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><a href="OutboundSseEvent.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#build()">build</a></span>()</code></th>
<td class="colLast">
<div class="block">Build <a href="OutboundSseEvent.html" title="interface in jakarta.ws.rs.sse"><code>OutboundSseEvent</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="OutboundSseEvent.Builder.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#comment(java.lang.String)">comment</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;comment)</code></th>
<td class="colLast">
<div class="block">Set comment string associated with the event.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="OutboundSseEvent.Builder.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#data(jakarta.ws.rs.core.GenericType,java.lang.Object)">data</a></span>&#8203;(<a href="../core/GenericType.html" title="class in jakarta.ws.rs.core">GenericType</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;data)</code></th>
<td class="colLast">
<div class="block">Set event data and a generic java type of event data.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="OutboundSseEvent.Builder.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#data(java.lang.Class,java.lang.Object)">data</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;data)</code></th>
<td class="colLast">
<div class="block">Set event data and java type of event data.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="OutboundSseEvent.Builder.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#data(java.lang.Object)">data</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;data)</code></th>
<td class="colLast">
<div class="block">Set event data and java type of event data.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="OutboundSseEvent.Builder.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#id(java.lang.String)">id</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;id)</code></th>
<td class="colLast">
<div class="block">Set the event id.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="OutboundSseEvent.Builder.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mediaType(jakarta.ws.rs.core.MediaType)">mediaType</a></span>&#8203;(<a href="../core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&nbsp;mediaType)</code></th>
<td class="colLast">
<div class="block">Set the <a href="../core/MediaType.html" title="class in jakarta.ws.rs.core"><code>media type</code></a> of the event data.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="OutboundSseEvent.Builder.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#name(java.lang.String)">name</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Set event name.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="OutboundSseEvent.Builder.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reconnectDelay(long)">reconnectDelay</a></span>&#8203;(long&nbsp;milliseconds)</code></th>
<td class="colLast">
<div class="block">Set reconnection delay (in milliseconds) that indicates how long the event receiver should wait before attempting to
reconnect in case a connection to SSE event source is lost.</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="id(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>id</h4>
<pre class="methodSignature"><a href="OutboundSseEvent.Builder.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent.Builder</a>&nbsp;id&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;id)</pre>
<div class="block">Set the event id.
<p>
Will be send as a value of the SSE <code>"id"</code> field. This field is optional.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - event id.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>updated builder instance.</dd>
</dl>
</li>
</ul>
<a id="name(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre class="methodSignature"><a href="OutboundSseEvent.Builder.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent.Builder</a>&nbsp;name&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</pre>
<div class="block">Set event name.
<p>
Will be send as a value of the SSE <code>"event"</code> field. This field is optional.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - event name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>updated builder instance.</dd>
</dl>
</li>
</ul>
<a id="reconnectDelay(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reconnectDelay</h4>
<pre class="methodSignature"><a href="OutboundSseEvent.Builder.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent.Builder</a>&nbsp;reconnectDelay&#8203;(long&nbsp;milliseconds)</pre>
<div class="block">Set reconnection delay (in milliseconds) that indicates how long the event receiver should wait before attempting to
reconnect in case a connection to SSE event source is lost.
<p>
Will be send as a value of the SSE <code>"retry"</code> field. This field is optional.
<p>
Absence of a value of this field in an <a href="OutboundSseEvent.html" title="interface in jakarta.ws.rs.sse"><code>OutboundSseEvent</code></a> instance is indicated by
<a href="SseEvent.html#RECONNECT_NOT_SET"><code>SseEvent.RECONNECT_NOT_SET</code></a> value returned from <a href="SseEvent.html#getReconnectDelay()"><code>SseEvent.getReconnectDelay()</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>milliseconds</code> - reconnection delay in milliseconds. Negative values un-set the reconnection delay.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>updated builder instance.</dd>
</dl>
</li>
</ul>
<a id="mediaType(jakarta.ws.rs.core.MediaType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mediaType</h4>
<pre class="methodSignature"><a href="OutboundSseEvent.Builder.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent.Builder</a>&nbsp;mediaType&#8203;(<a href="../core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&nbsp;mediaType)</pre>
<div class="block">Set the <a href="../core/MediaType.html" title="class in jakarta.ws.rs.core"><code>media type</code></a> of the event data.
<p>
This information is mandatory. The default value is <a href="../core/MediaType.html#TEXT_PLAIN"><code>MediaType.TEXT_PLAIN</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mediaType</code> - <a href="../core/MediaType.html" title="class in jakarta.ws.rs.core"><code>MediaType</code></a> of event data. Must not be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>updated builder instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - in case the <code>mediaType</code> parameter is <code>null</code>.</dd>
</dl>
</li>
</ul>
<a id="comment(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>comment</h4>
<pre class="methodSignature"><a href="OutboundSseEvent.Builder.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent.Builder</a>&nbsp;comment&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;comment)</pre>
<div class="block">Set comment string associated with the event.
<p>
The comment will be serialized with the event, before event data are serialized. If the event does not contain any
data, a separate "event" that contains only the comment will be sent. This information is optional, provided the
event data are set.
<p>
Note that multiple invocations of this method result in a previous comment being replaced with a new one. To achieve
multi-line comments, a multi-line comment string has to be used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>comment</code> - comment string.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>updated builder instance.</dd>
</dl>
</li>
</ul>
<a id="data(java.lang.Class,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>data</h4>
<pre class="methodSignature"><a href="OutboundSseEvent.Builder.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent.Builder</a>&nbsp;data&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;data)</pre>
<div class="block">Set event data and java type of event data.
<p>
Type information will be used for <a href="../ext/MessageBodyWriter.html" title="interface in jakarta.ws.rs.ext"><code>MessageBodyWriter</code></a> lookup.
<p>
Note that multiple invocations of this method result in previous even data being replaced with new one.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - java type of supplied data. Must not be <code>null</code>.</dd>
<dd><code>data</code> - event data. Must not be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>updated builder instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - in case either <code>type</code> or <code>data</code> parameter is <code>null</code>.</dd>
</dl>
</li>
</ul>
<a id="data(jakarta.ws.rs.core.GenericType,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>data</h4>
<pre class="methodSignature"><a href="OutboundSseEvent.Builder.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent.Builder</a>&nbsp;data&#8203;(<a href="../core/GenericType.html" title="class in jakarta.ws.rs.core">GenericType</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;data)</pre>
<div class="block">Set event data and a generic java type of event data.
<p>
Type information will be used for <a href="../ext/MessageBodyWriter.html" title="interface in jakarta.ws.rs.ext"><code>MessageBodyWriter</code></a> lookup.
<p>
Note that multiple invocations of this method result in previous even data being replaced with new one.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - generic type of supplied data. Must not be <code>null</code>.</dd>
<dd><code>data</code> - event data. Must not be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>updated builder instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - in case either <code>type</code> or <code>data</code> parameter is <code>null</code>.</dd>
</dl>
</li>
</ul>
<a id="data(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>data</h4>
<pre class="methodSignature"><a href="OutboundSseEvent.Builder.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent.Builder</a>&nbsp;data&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;data)</pre>
<div class="block">Set event data and java type of event data.
<p>
This is a convenience method that derives the event data type information from the runtime type of the event data.
The supplied event data may be represented as <a href="../core/GenericEntity.html" title="class in jakarta.ws.rs.core"><code>GenericEntity</code></a>.
<p>
Note that multiple invocations of this method result in previous even data being replaced with new one.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - event data. Must not be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>updated builder instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - in case the <code>data</code> parameter is <code>null</code>.</dd>
</dl>
</li>
</ul>
<a id="build()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre class="methodSignature"><a href="OutboundSseEvent.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent</a>&nbsp;build()</pre>
<div class="block">Build <a href="OutboundSseEvent.html" title="interface in jakarta.ws.rs.sse"><code>OutboundSseEvent</code></a>.
<p>
There are two valid configurations:
<ul>
<li>if a <a href="#comment(java.lang.String)"><code>comment</code></a> is set, all other parameters are optional. If event
<a href="#data(java.lang.Class,java.lang.Object)"><code>data</code></a> and <a href="#mediaType(jakarta.ws.rs.core.MediaType)"><code>media type</code></a> is set, event data will
be serialized after the comment.</li>
<li>if a <a href="#comment(java.lang.String)"><code>comment</code></a> is not set, at least the event <a href="#data(java.lang.Class,java.lang.Object)"><code>data</code></a> must be set. All other parameters are optional.</li>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new <a href="OutboundSseEvent.html" title="interface in jakarta.ws.rs.sse"><code>OutboundSseEvent</code></a> instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - when called with invalid configuration (neither a comment nor event data are set).</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/OutboundSseEvent.Builder.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><p align="left">Copyright &#169; 2018, 2020 Eclipse Foundation.<br>Use is subject to <a href="../../../../resources/EFSL.html" target="_top">license terms</a>.</small></p>
</footer>
</body>
</html>