fish.payara.microprofile.openapi.impl.model.parameters

Class ParameterImpl

java.lang.Object

fish.payara.microprofile.openapi.impl.model.ExtensibleImpl

fish.payara.microprofile.openapi.impl.model.parameters.ParameterImpl

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.Reference<org.eclipse.microprofile.openapi.models.parameters.Parameter>

public class ParameterImpl
extends ExtensibleImpl
implements org.eclipse.microprofile.openapi.models.parameters.Parameter

Nested Class Summary

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

Modifier and Type	Field and Description
protected Boolean	allowEmptyValue
protected Boolean	allowReserved
protected org.eclipse.microprofile.openapi.models.media.Content	content
protected Boolean	deprecated
protected String	description
protected Object	example
protected Map<String,org.eclipse.microprofile.openapi.models.examples.Example>	examples
protected Boolean	explode
protected org.eclipse.microprofile.openapi.models.parameters.Parameter.In	in
protected String	name
protected String	ref
protected Boolean	required
protected org.eclipse.microprofile.openapi.models.media.Schema	schema
protected org.eclipse.microprofile.openapi.models.parameters.Parameter.Style	style

Fields inherited from class fish.payara.microprofile.openapi.impl.model.ExtensibleImpl

extensions

Constructor Summary

Constructors

Constructor and Description
ParameterImpl()

Method Summary

Modifier and Type	Method and Description
org.eclipse.microprofile.openapi.models.parameters.Parameter	addExample(String key, org.eclipse.microprofile.openapi.models.examples.Example example)
org.eclipse.microprofile.openapi.models.parameters.Parameter	allowEmptyValue(Boolean allowEmptyValue)
org.eclipse.microprofile.openapi.models.parameters.Parameter	allowReserved(Boolean allowReserved)
org.eclipse.microprofile.openapi.models.parameters.Parameter	content(org.eclipse.microprofile.openapi.models.media.Content content)
org.eclipse.microprofile.openapi.models.parameters.Parameter	deprecated(Boolean deprecated)
org.eclipse.microprofile.openapi.models.parameters.Parameter	description(String description)
org.eclipse.microprofile.openapi.models.parameters.Parameter	example(Object example)
org.eclipse.microprofile.openapi.models.parameters.Parameter	examples(Map<String,org.eclipse.microprofile.openapi.models.examples.Example> examples)
org.eclipse.microprofile.openapi.models.parameters.Parameter	explode(Boolean explode)
Boolean	getAllowEmptyValue()
Boolean	getAllowReserved()
org.eclipse.microprofile.openapi.models.media.Content	getContent()
Boolean	getDeprecated()
String	getDescription()
Object	getExample()
Map<String,org.eclipse.microprofile.openapi.models.examples.Example>	getExamples()
Boolean	getExplode()
org.eclipse.microprofile.openapi.models.parameters.Parameter.In	getIn()
String	getName()
String	getRef()
Boolean	getRequired()
org.eclipse.microprofile.openapi.models.media.Schema	getSchema()
org.eclipse.microprofile.openapi.models.parameters.Parameter.Style	getStyle()
org.eclipse.microprofile.openapi.models.parameters.Parameter	in(org.eclipse.microprofile.openapi.models.parameters.Parameter.In in)
static void	merge(org.eclipse.microprofile.openapi.annotations.parameters.Parameter from, org.eclipse.microprofile.openapi.models.parameters.Parameter to, boolean override, Map<String,org.eclipse.microprofile.openapi.models.media.Schema> currentSchemas)
org.eclipse.microprofile.openapi.models.parameters.Parameter	name(String name)
org.eclipse.microprofile.openapi.models.parameters.Parameter	ref(String ref)
org.eclipse.microprofile.openapi.models.parameters.Parameter	required(Boolean required)
org.eclipse.microprofile.openapi.models.parameters.Parameter	schema(org.eclipse.microprofile.openapi.models.media.Schema schema)
void	setAllowEmptyValue(Boolean allowEmptyValue)
void	setAllowReserved(Boolean allowReserved)
void	setContent(org.eclipse.microprofile.openapi.models.media.Content content)
void	setDeprecated(Boolean deprecated)
void	setDescription(String description)
void	setExample(Object example)
void	setExamples(Map<String,org.eclipse.microprofile.openapi.models.examples.Example> examples)
void	setExplode(Boolean explode)
void	setIn(org.eclipse.microprofile.openapi.models.parameters.Parameter.In in)
void	setName(String name)
void	setRef(String ref)
void	setRequired(Boolean required)
void	setSchema(org.eclipse.microprofile.openapi.models.media.Schema schema)
void	setStyle(org.eclipse.microprofile.openapi.models.parameters.Parameter.Style style)
org.eclipse.microprofile.openapi.models.parameters.Parameter	style(org.eclipse.microprofile.openapi.models.parameters.Parameter.Style style)

Methods inherited from class fish.payara.microprofile.openapi.impl.model.ExtensibleImpl

addExtension, convertExtensionValue, getExtensions, merge, 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, getExtensions, setExtensions

Field Detail

name

protected String name

in

protected org.eclipse.microprofile.openapi.models.parameters.Parameter.In in

description

protected String description

required

protected Boolean required

deprecated

protected Boolean deprecated

allowEmptyValue

protected Boolean allowEmptyValue

ref

protected String ref

style

protected org.eclipse.microprofile.openapi.models.parameters.Parameter.Style style

explode

protected Boolean explode

allowReserved

protected Boolean allowReserved

schema

protected org.eclipse.microprofile.openapi.models.media.Schema schema

examples

protected Map<String,org.eclipse.microprofile.openapi.models.examples.Example> examples

example

protected Object example

content

protected org.eclipse.microprofile.openapi.models.media.Content content

Constructor Detail

ParameterImpl

public ParameterImpl()

Method Detail

getName

public String getName()

Specified by:

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

setName

public void setName(String name)

Specified by:

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

name

public org.eclipse.microprofile.openapi.models.parameters.Parameter name(String name)

Specified by:

name in interface 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 in)

Specified by:

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

in

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

Specified by:

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

getDescription

public String getDescription()

Specified by:

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

setDescription

public void setDescription(String description)

Specified by:

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

description

public org.eclipse.microprofile.openapi.models.parameters.Parameter description(String description)

Specified by:

description 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 required)

Specified by:

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

required

public org.eclipse.microprofile.openapi.models.parameters.Parameter required(Boolean required)

Specified by:

required 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 deprecated)

Specified by:

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

deprecated

public org.eclipse.microprofile.openapi.models.parameters.Parameter deprecated(Boolean deprecated)

Specified by:

deprecated 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 allowEmptyValue)

Specified by:

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

allowEmptyValue

public org.eclipse.microprofile.openapi.models.parameters.Parameter allowEmptyValue(Boolean allowEmptyValue)

Specified by:

allowEmptyValue 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 style)

Specified by:

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

style

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

Specified by:

style 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 explode)

Specified by:

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

explode

public org.eclipse.microprofile.openapi.models.parameters.Parameter explode(Boolean explode)

Specified by:

explode 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 allowReserved)

Specified by:

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

allowReserved

public org.eclipse.microprofile.openapi.models.parameters.Parameter allowReserved(Boolean allowReserved)

Specified by:

allowReserved 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 schema)

Specified by:

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

schema

public org.eclipse.microprofile.openapi.models.parameters.Parameter schema(org.eclipse.microprofile.openapi.models.media.Schema schema)

Specified by:

schema 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> examples)

Specified by:

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

examples

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

Specified by:

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

addExample

public org.eclipse.microprofile.openapi.models.parameters.Parameter addExample(String key,
                                                                               org.eclipse.microprofile.openapi.models.examples.Example example)

Specified by:

addExample 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 example)

Specified by:

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

example

public org.eclipse.microprofile.openapi.models.parameters.Parameter example(Object example)

Specified by:

example 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 content)

Specified by:

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

content

public org.eclipse.microprofile.openapi.models.parameters.Parameter content(org.eclipse.microprofile.openapi.models.media.Content content)

Specified by:

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

getRef

public String getRef()

Specified by:

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

setRef

public void setRef(String ref)

Specified by:

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

ref

public org.eclipse.microprofile.openapi.models.parameters.Parameter ref(String ref)

Specified by:

ref in interface org.eclipse.microprofile.openapi.models.Reference<org.eclipse.microprofile.openapi.models.parameters.Parameter>

merge

public static void merge(org.eclipse.microprofile.openapi.annotations.parameters.Parameter from,
                         org.eclipse.microprofile.openapi.models.parameters.Parameter to,
                         boolean override,
                         Map<String,org.eclipse.microprofile.openapi.models.media.Schema> currentSchemas)