Package io.smallrye.openapi.internal.models.parameters

Class Parameter

java.lang.Object

io.smallrye.openapi.model.BaseModel<org.eclipse.microprofile.openapi.models.parameters.Parameter>

io.smallrye.openapi.model.BaseExtensibleModel<org.eclipse.microprofile.openapi.models.parameters.Parameter>

io.smallrye.openapi.internal.models.parameters.Parameter

All Implemented Interfaces:

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

Direct Known Subclasses:

ParameterImpl

@Generated(value="io.smallrye.openapi.model.apt.SmallRyeModelProcessor",
           date="2024-12-09T01:23:59.676719863Z")
public class Parameter
extends BaseExtensibleModel<org.eclipse.microprofile.openapi.models.parameters.Parameter>
implements org.eclipse.microprofile.openapi.models.parameters.Parameter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Parameter.Properties

Nested classes/interfaces inherited from class io.smallrye.openapi.model.BaseModel

BaseModel.MergeDirective

Nested classes/interfaces inherited from interface org.eclipse.microprofile.openapi.models.parameters.Parameter

org.eclipse.microprofile.openapi.models.parameters.Parameter.In, org.eclipse.microprofile.openapi.models.parameters.Parameter.Style

Field Summary

Fields inherited from class io.smallrye.openapi.model.BaseModel

properties

Constructor Summary

Constructors

Constructor	Description
Parameter()

Method Summary

Modifier and Type	Method	Description
Parameter	addExample(String newKey, org.eclipse.microprofile.openapi.models.examples.Example newValue)
protected org.eclipse.microprofile.openapi.models.parameters.Parameter	filter(org.eclipse.microprofile.openapi.OASFilter filter)
Boolean	getAllowEmptyValue()
Boolean	getAllowReserved()
org.eclipse.microprofile.openapi.models.media.Content	getContent()
Boolean	getDeprecated()
Object	getExample()
Map<String,org.eclipse.microprofile.openapi.models.examples.Example>	getExamples()
Boolean	getExplode()
org.eclipse.microprofile.openapi.models.parameters.Parameter.In	getIn()
Boolean	getRequired()
org.eclipse.microprofile.openapi.models.media.Schema	getSchema()
org.eclipse.microprofile.openapi.models.parameters.Parameter.Style	getStyle()
void	removeExample(String key)
void	setAllowEmptyValue(Boolean newValue)
void	setAllowReserved(Boolean newValue)
void	setContent(org.eclipse.microprofile.openapi.models.media.Content newValue)
void	setDeprecated(Boolean newValue)
void	setExample(Object newValue)
void	setExamples(Map<String,org.eclipse.microprofile.openapi.models.examples.Example> newValue)
void	setExplode(Boolean newValue)
void	setIn(org.eclipse.microprofile.openapi.models.parameters.Parameter.In newValue)
void	setRequired(Boolean newValue)
void	setSchema(org.eclipse.microprofile.openapi.models.media.Schema newValue)
void	setStyle(org.eclipse.microprofile.openapi.models.parameters.Parameter.Style newValue)

Methods inherited from class io.smallrye.openapi.model.BaseExtensibleModel

addExtension, addListPropertyEntry, equals, getAllExtensions, getAllProperties, getExtension, getExtensions, getListProperty, getMapProperty, getProperty, getProperty, hashCode, isExtension, merge, putMapPropertyEntry, removeExtension, removeListPropertyEntry, removeMapPropertyEntry, setAllProperties, setExtensions, setListProperty, setMapProperty, setProperty

Methods inherited from class io.smallrye.openapi.model.BaseModel

constructible, deepCopy, filter, getDescription, getExternalDocs, getModCount, getName, getProperties, getRef, getSummary, incrementModCount, merge, mergeDirective, setDescription, setExternalDocs, setName, setRef, setSummary, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, 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.parameters.Parameter

allowEmptyValue, allowReserved, content, deprecated, description, example, examples, explode, getDescription, getName, in, name, required, schema, setDescription, setName, style

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

getRef, ref, setRef

Constructor Details

Parameter

public Parameter()

Method Details

filter

protected org.eclipse.microprofile.openapi.models.parameters.Parameter filter(org.eclipse.microprofile.openapi.OASFilter filter)

Overrides:

filter in class BaseModel<org.eclipse.microprofile.openapi.models.parameters.Parameter>

getIn

public org.eclipse.microprofile.openapi.models.parameters.Parameter.In getIn()

Specified by:

getIn in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

setIn

public void setIn(org.eclipse.microprofile.openapi.models.parameters.Parameter.In newValue)

Specified by:

setIn in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

getRequired

public Boolean getRequired()

Specified by:

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

setRequired

public void setRequired(Boolean newValue)

Specified by:

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

getSchema

public org.eclipse.microprofile.openapi.models.media.Schema getSchema()

Specified by:

getSchema in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

setSchema

public void setSchema(org.eclipse.microprofile.openapi.models.media.Schema newValue)

Specified by:

setSchema in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

getAllowEmptyValue

public Boolean getAllowEmptyValue()

Specified by:

getAllowEmptyValue in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

setAllowEmptyValue

public void setAllowEmptyValue(Boolean newValue)

Specified by:

setAllowEmptyValue in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

getDeprecated

public Boolean getDeprecated()

Specified by:

getDeprecated in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

setDeprecated

public void setDeprecated(Boolean newValue)

Specified by:

setDeprecated in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

getStyle

public org.eclipse.microprofile.openapi.models.parameters.Parameter.Style getStyle()

Specified by:

getStyle in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

setStyle

public void setStyle(org.eclipse.microprofile.openapi.models.parameters.Parameter.Style newValue)

Specified by:

setStyle in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

getExplode

public Boolean getExplode()

Specified by:

getExplode in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

setExplode

public void setExplode(Boolean newValue)

Specified by:

setExplode in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

getAllowReserved

public Boolean getAllowReserved()

Specified by:

getAllowReserved in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

setAllowReserved

public void setAllowReserved(Boolean newValue)

Specified by:

setAllowReserved in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

getExample

public Object getExample()

Specified by:

getExample in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

setExample

public void setExample(Object newValue)

Specified by:

setExample in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

getExamples

public Map<String,org.eclipse.microprofile.openapi.models.examples.Example> getExamples()

Specified by:

getExamples in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

setExamples

public void setExamples(Map<String,org.eclipse.microprofile.openapi.models.examples.Example> newValue)

Specified by:

setExamples in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

addExample

public Parameter addExample(String newKey,
 org.eclipse.microprofile.openapi.models.examples.Example newValue)

Specified by:

addExample in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

removeExample

public void removeExample(String key)

Specified by:

removeExample in interface org.eclipse.microprofile.openapi.models.parameters.Parameter

getContent

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

Specified by:

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

setContent

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

Specified by:

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