Package io.smallrye.openapi.api.models.parameters

Class RequestBodyImpl

java.lang.Object

io.smallrye.openapi.api.models.ExtensibleImpl<org.eclipse.microprofile.openapi.models.parameters.RequestBody>

io.smallrye.openapi.api.models.parameters.RequestBodyImpl

All Implemented Interfaces:

ModelImpl, org.eclipse.microprofile.openapi.models.Constructible, org.eclipse.microprofile.openapi.models.Extensible<org.eclipse.microprofile.openapi.models.parameters.RequestBody>, org.eclipse.microprofile.openapi.models.parameters.RequestBody, org.eclipse.microprofile.openapi.models.Reference<org.eclipse.microprofile.openapi.models.parameters.RequestBody>

public class RequestBodyImpl
extends ExtensibleImpl<org.eclipse.microprofile.openapi.models.parameters.RequestBody>
implements org.eclipse.microprofile.openapi.models.parameters.RequestBody, ModelImpl

An implementation of the RequestBody OpenAPI model interface.

Constructor Summary

Constructors

Constructor	Description
RequestBodyImpl()

Method Summary

Modifier and Type	Method	Description
org.eclipse.microprofile.openapi.models.media.Content	getContent()
String	getDescription()
String	getRef()
Boolean	getRequired()
static boolean	isRequiredSet(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody)	Returns whether setRequired(Boolean) has been called on a request body.
void	setContent(org.eclipse.microprofile.openapi.models.media.Content content)
void	setDescription(String description)
void	setRef(String ref)
void	setRequired(Boolean required)
RequestBodyImpl	setRequiredDefault(Boolean requiredDefault)	Sets the value to use for required if setRequired(Boolean) has not been called.

Methods inherited from class io.smallrye.openapi.api.models.ExtensibleImpl

addExtension, getExtensions, removeExtension, setExtensions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible

addExtension, extensions, getExtensions, removeExtension, setExtensions

Methods inherited from interface org.eclipse.microprofile.openapi.models.Reference

ref

Methods inherited from interface org.eclipse.microprofile.openapi.models.parameters.RequestBody

content, description, required

Constructor Details

RequestBodyImpl

public RequestBodyImpl()

Method Details

getRef

public String getRef()

Specified by:

getRef in interface org.eclipse.microprofile.openapi.models.Reference<org.eclipse.microprofile.openapi.models.parameters.RequestBody>

See Also:

• Reference.getRef()

setRef

public void setRef(String ref)

Specified by:

setRef in interface org.eclipse.microprofile.openapi.models.Reference<org.eclipse.microprofile.openapi.models.parameters.RequestBody>

See Also:

• Reference.setRef(java.lang.String)

getDescription

public String getDescription()

Specified by:

getDescription in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody

See Also:

• RequestBody.getDescription()

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody

See Also:

• RequestBody.setDescription(java.lang.String)

getContent

public org.eclipse.microprofile.openapi.models.media.Content getContent()

Specified by:

getContent in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody

See Also:

• RequestBody.getContent()

setContent

public void setContent(org.eclipse.microprofile.openapi.models.media.Content content)

Specified by:

setContent in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody

See Also:

• RequestBody.setContent(org.eclipse.microprofile.openapi.models.media.Content)

getRequired

public Boolean getRequired()

Specified by:

getRequired in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody

See Also:

• RequestBody.getRequired()

setRequired

public void setRequired(Boolean required)

Specified by:

setRequired in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody

See Also:

• RequestBody.setRequired(java.lang.Boolean)

setRequiredDefault

public RequestBodyImpl setRequiredDefault(Boolean requiredDefault)

Sets the value to use for required if setRequired(Boolean) has not been called.

If this method is called, getRequired() will return this value unless setRequired(Boolean) is called.

Parameters:

requiredDefault - the default value for required

Returns:

this instance

isRequiredSet

public static boolean isRequiredSet(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody)

Returns whether setRequired(Boolean) has been called on a request body.

Always returns true if the request body is not a RequestBodyImpl

Parameters:

requestBody - the request body

Returns:

true if setRequired has been called