001/*
002 * Copyright 2022-2026 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.soklet;
018
019import org.jspecify.annotations.NonNull;
020
021import javax.annotation.concurrent.ThreadSafe;
022import java.util.Optional;
023
024/**
025 * One immutable, exactly encoded simulated SSE item.
026 *
027 * @author <a href="https://www.revetkn.com">Mark Allen</a>
028 */
029@ThreadSafe
030public interface McpSimulationStreamItem {
031        /** @return the item kind */
032        @NonNull
033        McpSimulationStreamItemType getType();
034
035        /** @return the JSON value for a JSON-message item, otherwise empty */
036        @NonNull
037        Optional<@NonNull McpJsonValue> getMessage();
038
039        /**
040         * @return exactly {@code keepalive} for a keep-alive comment, otherwise empty
041         */
042        @NonNull
043        Optional<@NonNull String> getComment();
044
045        /**
046         * The bytes are the exact canonical unchunked SSE frame corresponding to the
047         * mutually exclusive message or comment projection.
048         *
049         * @return a fresh copy of the exact unchunked SSE frame
050         */
051        byte @NonNull [] getEncodedBytes();
052}