io.muserver.openapi

Class ServerVariableObjectBuilder

java.lang.Object

io.muserver.openapi.ServerVariableObjectBuilder

public class ServerVariableObjectBuilder
extends Object

An object representing a Server Variable for server URL template substitution.

Constructor Summary

Constructors

Constructor and Description
ServerVariableObjectBuilder()

Method Summary

Modifier and Type	Method and Description
ServerVariableObject	build()
static ServerVariableObjectBuilder	serverVariableObject() Creates a builder for a ServerVariableObjectBuilder
ServerVariableObjectBuilder	withDefaultValue(String defaultValue)
ServerVariableObjectBuilder	withDescription(String description)
ServerVariableObjectBuilder	withEnumValues(List<String> enumValues)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServerVariableObjectBuilder

public ServerVariableObjectBuilder()

Method Detail

withEnumValues

public ServerVariableObjectBuilder withEnumValues(List<String> enumValues)

Parameters:

enumValues - An enumeration of string values to be used if the substitution options are from a limited set.

Returns:

The current builder

withDefaultValue

public ServerVariableObjectBuilder withDefaultValue(String defaultValue)

Parameters:

defaultValue - REQUIRED. The default value to use for substitution, and to send, if an alternate value is not supplied. Unlike the Schema Object's default, this value MUST be provided by the consumer.

Returns:

The current builder

withDescription

public ServerVariableObjectBuilder withDescription(String description)

Parameters:

description - An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.

Returns:

The current builder

build

public ServerVariableObject build()

serverVariableObject

public static ServerVariableObjectBuilder serverVariableObject()

Creates a builder for a ServerVariableObjectBuilder

Returns:

A new builder