/*
 * Copyright 2017-2020 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.http.sse;

import io.micronaut.core.util.ArgumentUtils;

import edu.umd.cs.findbugs.annotations.Nullable;
import java.time.Duration;

Represents a Server Sent Event. See https://www.w3.org/TR/2011/WD-eventsource-20111020/.
Author:
Graeme Rocher
Type parameters:
<T> – The event type
Since:
1.0/**
 * Represents a Server Sent Event. See https://www.w3.org/TR/2011/WD-eventsource-20111020/.
 *
 * @param <T> The event type
 * @author Graeme Rocher
 * @since 1.0
 */
public interface Event<T> {

    
The id parameter.
/**
     * The id parameter.
     */
    String ID = "id";

    
The event parameter.
/**
     * The event parameter.
     */
    String EVENT = "event";

    
The data parameter.
/**
     * The data parameter.
     */
    String DATA = "data";

    
The retry parameter.
/**
     * The retry parameter.
     */
    String RETRY = "retry";

    
Returns:
The data object to write/**
     * @return The data object to write
     */
    T getData();

    
Returns:
The ID of the event, or null if there is no ID/**
     * @return The ID of the event, or null if there is no ID
     */
    String getId();

    
Returns:
The name of the event/**
     * @return The name of the event
     */
    String getName();

    
Returns:
A comment for the event, or null if there is no comment/**
     * @return A comment for the event, or null if there is no comment
     */
    String getComment();

    
Returns:
The duration to retry/**
     * @return The duration to retry
     */
    Duration getRetry();

    
Sets the retry duration.
Params:
duration – The duration
Returns:
The event/**
     * Sets the retry duration.
     *
     * @param duration The duration
     * @return The event
     */
    Event<T> retry(@Nullable Duration duration);

    
Sets the id.
Params:
id – The id to set
Returns:
The event/**
     * Sets the id.
     *
     * @param id The id to set
     * @return The event
     */
    Event<T> id(@Nullable String id);

    
Sets the event name.
Params:
name – The event name
Returns:
The event/**
     * Sets the event name.
     *
     * @param name The event name
     * @return The event
     */
    Event<T> name(@Nullable String name);

    
Sets the event comment.
Params:
comment – The Event comment
Returns:
The event/**
     * Sets the event comment.
     *
     * @param comment The Event comment
     * @return The event
     */
    Event<T> comment(@Nullable String comment);

    
Constructs a new event for the given data.
Params:
data – The data
Type parameters:
<ET> – The data type
Returns:
The event instance/**
     * Constructs a new event for the given data.
     *
     * @param data The data
     * @param <ET> The data type
     * @return The event instance
     */
    static <ET> Event<ET> of(ET data) {
        ArgumentUtils.check("data", data).notNull();
        return new DefaultEvent<>(data);
    }

    
Constructs a new event for the given data.
Params:
event – The event
data –  The data
Type parameters:
<ET> –  The data type
Returns:
The event instance/**
     * Constructs a new event for the given data.
     *
     * @param event The event
     * @param data  The data
     * @param <ET>  The data type
     * @return The event instance
     */
    static <ET> Event<ET> of(Event event, ET data) {
        ArgumentUtils.check("data", data).notNull();
        return new DefaultEvent<>(data)
            .id(event.getId())
            .comment(event.getComment())
            .name(event.getName())
            .retry(event.getRetry());
    }
}