java.lang.Object
- io.smallrye.openapi.api.models.ExtensibleImpl<org.eclipse.microprofile.openapi.models.parameters.Parameter>
- - io.smallrye.openapi.api.models.parameters.ParameterImpl

All Implemented Interfaces:

ModelImpl, 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>
```
public class ParameterImpl
extends ExtensibleImpl<org.eclipse.microprofile.openapi.models.parameters.Parameter>
implements org.eclipse.microprofile.openapi.models.parameters.Parameter, ModelImpl
```
An implementation of the Parameter OpenAPI model interface.

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 Description

static String HIDDEN

Constructor Summary

Constructors
Constructor Description

ParameterImpl()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`org.eclipse.microprofile.openapi.models.parameters.Parameter`	`addExample(String key, org.eclipse.microprofile.openapi.models.examples.Example example)`
`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`	`getParamRef()`	Implementation specific, set a reference to the Java method parameter, so that we can bind back to it later if needed
`static String`	`getParamRef(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)`
`String`	`getRef()`
`Boolean`	`getRequired()`
`org.eclipse.microprofile.openapi.models.media.Schema`	`getSchema()`
`org.eclipse.microprofile.openapi.models.parameters.Parameter.Style`	`getStyle()`
`static boolean`	`isHidden(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)`
`void`	`removeExample(String key)`
`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)`
`static void`	`setHidden(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter, boolean hidden)`
`void`	`setIn(org.eclipse.microprofile.openapi.models.parameters.Parameter.In in)`
`void`	`setName(String name)`
`void`	`setParamRef(String paramRef)`
`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)`

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.parameters.Parameter
allowEmptyValue, allowReserved, content, deprecated, description, example, examples, explode, in, name, required, schema, style

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

- Field Detail
  - HIDDEN
```
public static final String HIDDEN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ParameterImpl
```
public ParameterImpl()
```
- Method Detail
  - getRef
```
public String getRef()
```
    Specified by:
    
    getRef in interface org.eclipse.microprofile.openapi.models.Reference<org.eclipse.microprofile.openapi.models.parameters.Parameter>
    
    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.Parameter>
    
    See Also:
    
    Reference.setRef(java.lang.String)
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.getName()
  - setName
```
public void setName(String name)
```
    Specified by:
    
    setName in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.setName(java.lang.String)
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.getDescription()
  - setDescription
```
public void setDescription(String description)
```
    Specified by:
    
    setDescription in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.setDescription(java.lang.String)
  - getRequired
```
public Boolean getRequired()
```
    Specified by:
    
    getRequired in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.getRequired()
  - setRequired
```
public void setRequired(Boolean required)
```
    Specified by:
    
    setRequired in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.setRequired(java.lang.Boolean)
  - getDeprecated
```
public Boolean getDeprecated()
```
    Specified by:
    
    getDeprecated in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.getDeprecated()
  - setDeprecated
```
public void setDeprecated(Boolean deprecated)
```
    Specified by:
    
    setDeprecated in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.setDeprecated(java.lang.Boolean)
  - getAllowEmptyValue
```
public Boolean getAllowEmptyValue()
```
    Specified by:
    
    getAllowEmptyValue in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.getAllowEmptyValue()
  - setAllowEmptyValue
```
public void setAllowEmptyValue(Boolean allowEmptyValue)
```
    Specified by:
    
    setAllowEmptyValue in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.setAllowEmptyValue(java.lang.Boolean)
  - getStyle
```
public org.eclipse.microprofile.openapi.models.parameters.Parameter.Style getStyle()
```
    Specified by:
    
    getStyle in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.getStyle()
  - 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
    
    See Also:
    
    Parameter.setStyle(Style)
  - getExplode
```
public Boolean getExplode()
```
    Specified by:
    
    getExplode in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.getExplode()
  - setExplode
```
public void setExplode(Boolean explode)
```
    Specified by:
    
    setExplode in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.setExplode(java.lang.Boolean)
  - getAllowReserved
```
public Boolean getAllowReserved()
```
    Specified by:
    
    getAllowReserved in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.getAllowReserved()
  - setAllowReserved
```
public void setAllowReserved(Boolean allowReserved)
```
    Specified by:
    
    setAllowReserved in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.setAllowReserved(java.lang.Boolean)
  - getSchema
```
public org.eclipse.microprofile.openapi.models.media.Schema getSchema()
```
    Specified by:
    
    getSchema in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.getSchema()
  - setSchema
```
public void setSchema(org.eclipse.microprofile.openapi.models.media.Schema schema)
```
    Specified by:
    
    setSchema in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.setSchema(org.eclipse.microprofile.openapi.models.media.Schema)
  - getExamples
```
public Map<String,org.eclipse.microprofile.openapi.models.examples.Example> getExamples()
```
    Specified by:
    
    getExamples in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.getExamples()
  - 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
    
    See Also:
    
    Parameter.setExamples(java.util.Map)
  - 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
    
    See Also:
    
    Parameter.addExample(java.lang.String, org.eclipse.microprofile.openapi.models.examples.Example)
  - removeExample
```
public void removeExample(String key)
```
    Specified by:
    
    removeExample in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.removeExample(java.lang.String)
  - getExample
```
public Object getExample()
```
    Specified by:
    
    getExample in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.getExample()
  - setExample
```
public void setExample(Object example)
```
    Specified by:
    
    setExample in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.setExample(java.lang.Object)
  - getContent
```
public org.eclipse.microprofile.openapi.models.media.Content getContent()
```
    Specified by:
    
    getContent in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.getContent()
  - setContent
```
public void setContent(org.eclipse.microprofile.openapi.models.media.Content content)
```
    Specified by:
    
    setContent in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.setContent(org.eclipse.microprofile.openapi.models.media.Content)
  - getIn
```
public org.eclipse.microprofile.openapi.models.parameters.Parameter.In getIn()
```
    Specified by:
    
    getIn in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
    
    See Also:
    
    Parameter.getIn()
  - 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
    
    See Also:
    
    Parameter.setIn(org.eclipse.microprofile.openapi.models.parameters.Parameter.In)
  - getParamRef
```
public String getParamRef()
```
    Implementation specific, set a reference to the Java method parameter, so that we can bind back to it later if needed
    
    Returns:
    
    reference to the method parameter that we scanned this on
  - setParamRef
```
public void setParamRef(String paramRef)
```
  - getParamRef
```
public static String getParamRef(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)
```
  - isHidden
```
public static boolean isHidden(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)
```
  - setHidden
```
public static void setHidden(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter,
                             boolean hidden)
```

Class ParameterImpl

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

HIDDEN

Constructor Detail

ParameterImpl

Method Detail

getRef

setRef

getName

setName

getDescription

setDescription

getRequired

setRequired

getDeprecated

setDeprecated

getAllowEmptyValue

setAllowEmptyValue

getStyle

setStyle

getExplode

setExplode

getAllowReserved

setAllowReserved

getSchema

setSchema

getExamples

setExamples

addExample

removeExample

getExample

setExample

getContent

setContent

getIn

setIn

getParamRef

setParamRef

getParamRef

isHidden

setHidden