Class ServerSentEventComment

java.lang.Object

com.soklet.ServerSentEventComment

@ThreadSafe
public final class ServerSentEventComment
extends Object

Encapsulates a Server-Sent Event comment payload and its comment type.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ServerSentEventComment.CommentType	Types of Server-Sent Event comments.

Method Summary

Modifier and Type	Method	Description
static @NonNull ServerSentEventComment	fromComment(@NonNull String comment)	Acquires a ServerSentEventComment instance with a comment payload.
@NonNull Optional<String>	getComment()	The comment payload.
@NonNull ServerSentEventComment.CommentType	getCommentType()	The comment type.
static @NonNull ServerSentEventComment	heartbeatInstance()	Acquires a shared heartbeat comment instance.
@NonNull String	toString()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

fromComment

public static @NonNull ServerSentEventComment fromComment(@NonNull String comment)

Acquires a ServerSentEventComment instance with a comment payload.

Parameters:

comment - the comment payload for the instance

Returns:

the comment instance

heartbeatInstance

public static @NonNull ServerSentEventComment heartbeatInstance()

Acquires a shared heartbeat comment instance.

Heartbeat comments do not carry a payload; getComment() will be empty.

Returns:

a shared heartbeat comment instance

getComment

public @NonNull Optional<String> getComment()

The comment payload.

Heartbeat comments return Optional.empty().

Returns:

the comment payload

getCommentType

public @NonNull ServerSentEventComment.CommentType getCommentType()

The comment type.

Returns:

the comment type

toString

public @NonNull String toString()

Overrides:

toString in class Object