io.muserver.openapi

Class ExampleObjectBuilder

java.lang.Object

io.muserver.openapi.ExampleObjectBuilder

public class ExampleObjectBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
ExampleObjectBuilder()

Method Summary

Modifier and Type	Method and Description
ExampleObject	build()
static ExampleObjectBuilder	exampleObject() Creates a builder for an ExampleObject
ExampleObjectBuilder	withDescription(String description)
ExampleObjectBuilder	withExternalValue(URI externalValue)
ExampleObjectBuilder	withSummary(String summary)
ExampleObjectBuilder	withValue(Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExampleObjectBuilder

public ExampleObjectBuilder()

Method Detail

withSummary

public ExampleObjectBuilder withSummary(String summary)

Parameters:

summary - Short description for the example.

Returns:

The current builder

withDescription

public ExampleObjectBuilder withDescription(String description)

Parameters:

description - Long description for the example. CommonMark syntax MAY be used for rich text representation.

Returns:

The current builder

withValue

public ExampleObjectBuilder withValue(Object value)

Parameters:

value - Embedded literal example. The value field and externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary.

Returns:

The current builder

withExternalValue

public ExampleObjectBuilder withExternalValue(URI externalValue)

Parameters:

externalValue - A URL that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The value field and externalValue field are mutually exclusive.

Returns:

The current builder

build

public ExampleObject build()

exampleObject

public static ExampleObjectBuilder exampleObject()

Creates a builder for an ExampleObject

Returns:

A new builder