ch.rasc.sse.eventbus

Class SseEvent.Builder

java.lang.Object

ch.rasc.sse.eventbus.SseEvent.Builder

Enclosing interface:

SseEvent

public static final class SseEvent.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SseEvent.Builder	addAllClientIds(Iterable<String> elements) Adds elements to clientIds set.
SseEvent.Builder	addAllExcludeClientIds(Iterable<String> elements) Adds elements to excludeClientIds set.
SseEvent.Builder	addClientId(String... elements) Adds elements to clientIds set.
SseEvent.Builder	addClientId(String element) Adds one element to clientIds set.
SseEvent.Builder	addExcludeClientId(String... elements) Adds elements to excludeClientIds set.
SseEvent.Builder	addExcludeClientId(String element) Adds one element to excludeClientIds set.
ch.rasc.sse.eventbus.ImmutableSseEvent	build() Builds a new ImmutableSseEvent.
SseEvent.Builder	clientIds(Iterable<String> elements) Sets or replaces all elements for clientIds set.
SseEvent.Builder	comment(Optional<String> comment) Initializes the optional value comment to comment.
SseEvent.Builder	comment(String comment) Initializes the optional value comment to comment.
SseEvent.Builder	data(Object data) Initializes the value for the data attribute.
SseEvent.Builder	event(String event) Initializes the value for the event attribute.
SseEvent.Builder	excludeClientIds(Iterable<String> elements) Sets or replaces all elements for excludeClientIds set.
SseEvent.Builder	from(SseEvent instance) Fill a builder with attribute values from the provided SseEvent instance.
SseEvent.Builder	id(Optional<String> id) Initializes the optional value id to id.
SseEvent.Builder	id(String id) Initializes the optional value id to id.
SseEvent.Builder	retry(Duration retry) Initializes the optional value retry to retry.
SseEvent.Builder	retry(Optional<? extends Duration> retry) Initializes the optional value retry to retry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

from

public final SseEvent.Builder from(SseEvent instance)

Fill a builder with attribute values from the provided SseEvent instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

addClientId

public final SseEvent.Builder addClientId(String element)

Adds one element to clientIds set.

Parameters:

element - A clientIds element

Returns:

this builder for use in a chained invocation

addClientId

public final SseEvent.Builder addClientId(String... elements)

Adds elements to clientIds set.

Parameters:

elements - An array of clientIds elements

Returns:

this builder for use in a chained invocation

clientIds

public final SseEvent.Builder clientIds(Iterable<String> elements)

Sets or replaces all elements for clientIds set.

Parameters:

elements - An iterable of clientIds elements

Returns:

this builder for use in a chained invocation

addAllClientIds

public final SseEvent.Builder addAllClientIds(Iterable<String> elements)

Adds elements to clientIds set.

Parameters:

elements - An iterable of clientIds elements

Returns:

this builder for use in a chained invocation

addExcludeClientId

public final SseEvent.Builder addExcludeClientId(String element)

Adds one element to excludeClientIds set.

Parameters:

element - A excludeClientIds element

Returns:

this builder for use in a chained invocation

addExcludeClientId

public final SseEvent.Builder addExcludeClientId(String... elements)

Adds elements to excludeClientIds set.

Parameters:

elements - An array of excludeClientIds elements

Returns:

this builder for use in a chained invocation

excludeClientIds

public final SseEvent.Builder excludeClientIds(Iterable<String> elements)

Sets or replaces all elements for excludeClientIds set.

Parameters:

elements - An iterable of excludeClientIds elements

Returns:

this builder for use in a chained invocation

addAllExcludeClientIds

public final SseEvent.Builder addAllExcludeClientIds(Iterable<String> elements)

Adds elements to excludeClientIds set.

Parameters:

elements - An iterable of excludeClientIds elements

Returns:

this builder for use in a chained invocation

event

public final SseEvent.Builder event(String event)

Initializes the value for the event attribute.

If not set, this attribute will have a default value as returned by the initializer of event.

Parameters:

event - The value for event

Returns:

this builder for use in a chained invocation

data

public final SseEvent.Builder data(Object data)

Initializes the value for the data attribute.

Parameters:

data - The value for data

Returns:

this builder for use in a chained invocation

retry

public final SseEvent.Builder retry(Duration retry)

Initializes the optional value retry to retry.

Parameters:

retry - The value for retry

Returns:

this builder for chained invocation

retry

public final SseEvent.Builder retry(Optional<? extends Duration> retry)

Initializes the optional value retry to retry.

Parameters:

retry - The value for retry

Returns:

this builder for use in a chained invocation

id

public final SseEvent.Builder id(String id)

Initializes the optional value id to id.

Parameters:

id - The value for id

Returns:

this builder for chained invocation

id

public final SseEvent.Builder id(Optional<String> id)

Initializes the optional value id to id.

Parameters:

id - The value for id

Returns:

this builder for use in a chained invocation

comment

public final SseEvent.Builder comment(String comment)

Initializes the optional value comment to comment.

Parameters:

comment - The value for comment

Returns:

this builder for chained invocation

comment

public final SseEvent.Builder comment(Optional<String> comment)

Initializes the optional value comment to comment.

Parameters:

comment - The value for comment

Returns:

this builder for use in a chained invocation

build

public ch.rasc.sse.eventbus.ImmutableSseEvent build()

Builds a new ImmutableSseEvent.

Returns:

An immutable instance of SseEvent

Throws:

IllegalStateException - if any required attributes are missing