Mokksy/dev.mokksy.mokksy/JavaBuildingStep

JavaBuildingStep

class JavaBuildingStep<P : Any>(source)

A Java-friendly wrapper around BuildingStep that exposes respondsWith, respondsWithStream, and respondsWithSseStream as instance methods accepting Consumer instead of Kotlin suspend lambdas.

Instances are returned by dev.mokksy.Mokksy's HTTP method stubs (get, post, etc.). Do not construct directly.

Example (Java):

StubHandle ping = mokksy.get(spec -> spec.path("/ping"))
      .respondsWith(builder -> builder.body("Pong"));
assert ping.matchCount() == 0;

All response-definition methods return a StubHandle which exposes StubHandle.matchCount and StubHandle.name for verifying stub invocation after tests.

Type Parameters

P

The type of the request payload.

Functions

fun respondsWith(configurer: Consumer<JavaResponseDefinitionBuilder<P, String>>): StubHandle

Configures a String response for this stub.

fun respondsWith(body: String): StubHandle

Configures a simple String response body for this stub with HTTP 200.

fun <T : Any> respondsWith(responseType: Class<T>, configurer: Consumer<JavaResponseDefinitionBuilder<P, T>>): StubHandle

Configures a typed response for this stub.

fun respondsWith(body: String, statusCode: Int): StubHandle

Configures a simple String response body with a custom HTTP status code.

respondsWithSseStream

fun respondsWithSseStream(configurer: Consumer<JavaStreamingResponseDefinitionBuilder<P, ServerSentEventMetadata<String>>>): StubHandle

Configures an SSE streaming response for this stub with ServerSentEventMetadata<String> chunks.

fun <T : Any> respondsWithSseStream(dataType: Class<T>, configurer: Consumer<JavaStreamingResponseDefinitionBuilder<P, ServerSentEventMetadata<T>>>): StubHandle

Configures a typed SSE streaming response for this stub.

respondsWithStatus

fun respondsWithStatus(statusCode: Int): StubHandle

Associates this stub with a body-free response carrying only an HTTP status code.

respondsWithStream

fun respondsWithStream(configurer: Consumer<JavaStreamingResponseDefinitionBuilder<P, String>>): StubHandle

Configures a String streaming response for this stub.

fun <T : Any> respondsWithStream(responseType: Class<T>, configurer: Consumer<JavaStreamingResponseDefinitionBuilder<P, T>>): StubHandle

Configures a typed streaming response for this stub.