OutboundSseEventImpl.BuilderImpl (Red Hat JBoss Enterprise Application Platform 7.2.0.GA public API)

java.lang.Object
- org.jboss.resteasy.plugins.providers.sse.OutboundSseEventImpl.BuilderImpl

All Implemented Interfaces:: OutboundSseEvent.Builder

Enclosing class:: OutboundSseEventImpl

public static class OutboundSseEventImpl.BuilderImpl
extends Object
implements OutboundSseEvent.Builder

Constructor Summary

Constructors
Constructor and Description

BuilderImpl()

Constructors
Constructor and Description
`BuilderImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OutboundSseEvent`	`build()` Build `OutboundSseEvent`.
`OutboundSseEvent.Builder`	`comment(String comment)` Set comment string associated with the event.
`OutboundSseEvent.Builder`	`data(Class type, Object data)` Set event data and java type of event data.
`OutboundSseEvent.Builder`	`data(GenericType type, Object data)` Set event data and a generic java type of event data.
`OutboundSseEvent.Builder`	`data(Object data)` Set event data and java type of event data.
`OutboundSseEvent.Builder`	`id(String id)` Set the event id.
`OutboundSseEvent.Builder`	`mediaType(MediaType mediaType)` Set the `media type` of the event data.
`OutboundSseEvent.Builder`	`name(String name)` Set event name.
`OutboundSseEvent.Builder`	`reconnectDelay(long milliseconds)` 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BuilderImpl
```
public BuilderImpl()
```
- Method Detail
  - name
```
public OutboundSseEvent.Builder name(String name)
```
    Description copied from interface: OutboundSseEvent.Builder
    
    Set event name.
    Will be send as a value of the SSE "event" field. This field is optional.
    
    Specified by:
    
    name in interface OutboundSseEvent.Builder
    
    Parameters:
    
    name - event name.
    
    Returns:
    
    updated builder instance.
  - id
```
public OutboundSseEvent.Builder id(String id)
```
    Description copied from interface: OutboundSseEvent.Builder
    
    Set the event id.
    Will be send as a value of the SSE "id" field. This field is optional.
    
    Specified by:
    
    id in interface OutboundSseEvent.Builder
    
    Parameters:
    
    id - event id.
    
    Returns:
    
    updated builder instance.
  - reconnectDelay
```
public OutboundSseEvent.Builder reconnectDelay(long milliseconds)
```
    Description copied from interface: OutboundSseEvent.Builder
    
    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.
    Will be send as a value of the SSE "retry" field. This field is optional.
    Absence of a value of this field in an OutboundSseEvent instance is indicated by SseEvent.RECONNECT_NOT_SET value returned from SseEvent.getReconnectDelay().
    
    Specified by:
    
    reconnectDelay in interface OutboundSseEvent.Builder
    
    Parameters:
    
    milliseconds - reconnection delay in milliseconds. Negative values un-set the reconnection delay.
    
    Returns:
    
    updated builder instance.
  - mediaType
```
public OutboundSseEvent.Builder mediaType(MediaType mediaType)
```
    Description copied from interface: OutboundSseEvent.Builder
    
    Set the media type of the event data.
    This information is mandatory. The default value is MediaType.TEXT_PLAIN.
    
    Specified by:
    
    mediaType in interface OutboundSseEvent.Builder
    
    Parameters:
    
    mediaType - MediaType of event data. Must not be null.
    
    Returns:
    
    updated builder instance.
  - comment
```
public OutboundSseEvent.Builder comment(String comment)
```
    Description copied from interface: OutboundSseEvent.Builder
    
    Set comment string associated with the event.
    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.
    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.
    
    Specified by:
    
    comment in interface OutboundSseEvent.Builder
    
    Parameters:
    
    comment - comment string.
    
    Returns:
    
    updated builder instance.
  - data
```
public OutboundSseEvent.Builder data(Class type,
                                     Object data)
```
    Description copied from interface: OutboundSseEvent.Builder
    
    Set event data and java type of event data.
    Type information will be used for MessageBodyWriter lookup.
    Note that multiple invocations of this method result in previous even data being replaced with new one.
    
    Specified by:
    
    data in interface OutboundSseEvent.Builder
    
    Parameters:
    
    type - java type of supplied data. Must not be null.
    
    data - event data. Must not be null.
    
    Returns:
    
    updated builder instance.
  - data
```
public OutboundSseEvent.Builder data(GenericType type,
                                     Object data)
```
    Description copied from interface: OutboundSseEvent.Builder
    
    Set event data and a generic java type of event data.
    Type information will be used for MessageBodyWriter lookup.
    Note that multiple invocations of this method result in previous even data being replaced with new one.
    
    Specified by:
    
    data in interface OutboundSseEvent.Builder
    
    Parameters:
    
    type - generic type of supplied data. Must not be null.
    
    data - event data. Must not be null.
    
    Returns:
    
    updated builder instance.
  - data
```
public OutboundSseEvent.Builder data(Object data)
```
    Description copied from interface: OutboundSseEvent.Builder
    
    Set event data and java type of event data.
    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 GenericEntity.
    Note that multiple invocations of this method result in previous even data being replaced with new one.
    
    Specified by:
    
    data in interface OutboundSseEvent.Builder
    
    Parameters:
    
    data - event data. Must not be null.
    
    Returns:
    
    updated builder instance.
  - build
```
public OutboundSseEvent build()
```
    Description copied from interface: OutboundSseEvent.Builder
    Build OutboundSseEvent.
    There are two valid configurations:
    - if a comment is set, all other parameters are optional. If event data and media type is set, event data will be serialized after the comment.
    - if a comment is not set, at least the event data must be set. All other parameters are optional.
    Specified by:
    
    build in interface OutboundSseEvent.Builder
    
    Returns:
    
    new OutboundSseEvent instance.

Class OutboundSseEventImpl.BuilderImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BuilderImpl

Method Detail

name

id

reconnectDelay

mediaType

comment

data

data

data

build