io.muserver.openapi

Class EncodingObjectBuilder

java.lang.Object

io.muserver.openapi.EncodingObjectBuilder

public class EncodingObjectBuilder
extends Object

A single encoding definition applied to a single schema property.

Constructor Summary

Constructors

Constructor and Description
EncodingObjectBuilder()

Method Summary

Modifier and Type	Method and Description
EncodingObject	build()
static EncodingObjectBuilder	encodingObject() Creates a builder for an EncodingObject
EncodingObjectBuilder	withAllowReserved(boolean allowReserved)
EncodingObjectBuilder	withContentType(String contentType)
EncodingObjectBuilder	withExplode(boolean explode)
EncodingObjectBuilder	withHeaders(Map<String,HeaderObject> headers)
EncodingObjectBuilder	withStyle(String style)

Methods inherited from class java.lang.Object

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

Constructor Detail

EncodingObjectBuilder

public EncodingObjectBuilder()

Method Detail

withContentType

public EncodingObjectBuilder withContentType(String contentType)

Parameters:

contentType - The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object - application/json; for array – the default is defined based on the inner type. The value can be a specific media type (e.g. application/json), a wildcard media type (e.g. image/*), or a comma-separated list of the two types.

Returns:

The current builder

withHeaders

public EncodingObjectBuilder withHeaders(Map<String,HeaderObject> headers)

Parameters:

headers - A map allowing additional information to be provided as headers, for example Content-Disposition. Content-Type is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a multipart.

Returns:

The current builder

withStyle

public EncodingObjectBuilder withStyle(String style)

Parameters:

style - Describes how a specific property value will be serialized depending on its type. See ParameterObjectBuilder.withStyle(String) for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.

Returns:

The current builder

withExplode

public EncodingObjectBuilder withExplode(boolean explode)

Parameters:

explode - When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.

Returns:

The current builder

withAllowReserved

public EncodingObjectBuilder withAllowReserved(boolean allowReserved)

Parameters:

allowReserved - Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.

Returns:

The current builder

build

public EncodingObject build()

encodingObject

public static EncodingObjectBuilder encodingObject()

Creates a builder for an EncodingObject

Returns:

A new builder