Mokksy/dev.mokksy.mokksy/JavaStreamingResponseDefinitionBuilder

JavaStreamingResponseDefinitionBuilder

class JavaStreamingResponseDefinitionBuilder<P : Any, T : Any>(source)

Java-friendly wrapper around StreamingResponseDefinitionBuilder that returns this from every mutating method, enabling fluent chaining without Kotlin-specific idioms.

Java callers receive this type from JavaBuildingStep.respondsWithStream and use it to configure the streaming HTTP response for a stub:

mokksy.get(spec -> spec.path("/stream"))
    .respondsWithStream(builder -> builder
        .chunks(List.of("Hello", " ", "World"))
        .delayBetweenChunksMillis(50));

Alternatively, supply chunks as a Stream:

mokksy.get(spec -> spec.path("/events"))
    .respondsWithStream(builder -> builder
        .chunks(Stream.of("data1", "data2")));

Type Parameters

The type of the request payload.

The type of each streamed chunk.

Functions

chunk

fun chunk(chunk: T): JavaStreamingResponseDefinitionBuilder<P, T>

Appends a single chunk to the streaming response, preserving insertion order.

chunks

fun chunks(chunks: Stream<T>): JavaStreamingResponseDefinitionBuilder<P, T>

Sets the chunks to stream from a Stream.

fun chunks(chunks: List<T>): JavaStreamingResponseDefinitionBuilder<P, T>

Sets the chunks to stream from a List.

contentType

fun contentType(contentType: ContentType): JavaStreamingResponseDefinitionBuilder<P, T>

fun contentType(contentType: String): JavaStreamingResponseDefinitionBuilder<P, T>

Sets the Content-Type of the streaming response.

delayBetweenChunksMillis

fun delayBetweenChunksMillis(millis: Long): JavaStreamingResponseDefinitionBuilder<P, T>

Sets the delay between consecutive chunks.

delayMillis

fun delayMillis(millis: Long): JavaStreamingResponseDefinitionBuilder<P, T>

Sets a delay before the response streaming begins.

header

fun header(name: String, value: String): JavaStreamingResponseDefinitionBuilder<P, T>

Adds a response header.

status

fun status(code: Int): JavaStreamingResponseDefinitionBuilder<P, T>

Sets the HTTP status code.