Class ParameterImpl
- 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 theParameter
OpenAPI model interface.
-
-
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
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
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
-
-
-
-
Field Detail
-
HIDDEN
public static final String HIDDEN
- See Also:
- Constant Field Values
-
-
Method Detail
-
getRef
public String getRef()
- Specified by:
getRef
in interfaceorg.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 interfaceorg.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 interfaceorg.eclipse.microprofile.openapi.models.parameters.Parameter
- See Also:
Parameter.getName()
-
setName
public void setName(String name)
- Specified by:
setName
in interfaceorg.eclipse.microprofile.openapi.models.parameters.Parameter
- See Also:
Parameter.setName(java.lang.String)
-
getDescription
public String getDescription()
- Specified by:
getDescription
in interfaceorg.eclipse.microprofile.openapi.models.parameters.Parameter
- See Also:
Parameter.getDescription()
-
setDescription
public void setDescription(String description)
- Specified by:
setDescription
in interfaceorg.eclipse.microprofile.openapi.models.parameters.Parameter
- See Also:
Parameter.setDescription(java.lang.String)
-
getRequired
public Boolean getRequired()
- Specified by:
getRequired
in interfaceorg.eclipse.microprofile.openapi.models.parameters.Parameter
- See Also:
Parameter.getRequired()
-
setRequired
public void setRequired(Boolean required)
- Specified by:
setRequired
in interfaceorg.eclipse.microprofile.openapi.models.parameters.Parameter
- See Also:
Parameter.setRequired(java.lang.Boolean)
-
getDeprecated
public Boolean getDeprecated()
- Specified by:
getDeprecated
in interfaceorg.eclipse.microprofile.openapi.models.parameters.Parameter
- See Also:
Parameter.getDeprecated()
-
setDeprecated
public void setDeprecated(Boolean deprecated)
- Specified by:
setDeprecated
in interfaceorg.eclipse.microprofile.openapi.models.parameters.Parameter
- See Also:
Parameter.setDeprecated(java.lang.Boolean)
-
getAllowEmptyValue
public Boolean getAllowEmptyValue()
- Specified by:
getAllowEmptyValue
in interfaceorg.eclipse.microprofile.openapi.models.parameters.Parameter
- See Also:
Parameter.getAllowEmptyValue()
-
setAllowEmptyValue
public void setAllowEmptyValue(Boolean allowEmptyValue)
- Specified by:
setAllowEmptyValue
in interfaceorg.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 interfaceorg.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 interfaceorg.eclipse.microprofile.openapi.models.parameters.Parameter
- See Also:
Parameter.setStyle(Style)
-
getExplode
public Boolean getExplode()
- Specified by:
getExplode
in interfaceorg.eclipse.microprofile.openapi.models.parameters.Parameter
- See Also:
Parameter.getExplode()
-
setExplode
public void setExplode(Boolean explode)
- Specified by:
setExplode
in interfaceorg.eclipse.microprofile.openapi.models.parameters.Parameter
- See Also:
Parameter.setExplode(java.lang.Boolean)
-
getAllowReserved
public Boolean getAllowReserved()
- Specified by:
getAllowReserved
in interfaceorg.eclipse.microprofile.openapi.models.parameters.Parameter
- See Also:
Parameter.getAllowReserved()
-
setAllowReserved
public void setAllowReserved(Boolean allowReserved)
- Specified by:
setAllowReserved
in interfaceorg.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 interfaceorg.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 interfaceorg.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 interfaceorg.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 interfaceorg.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 interfaceorg.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 interfaceorg.eclipse.microprofile.openapi.models.parameters.Parameter
- See Also:
Parameter.removeExample(java.lang.String)
-
getExample
public Object getExample()
- Specified by:
getExample
in interfaceorg.eclipse.microprofile.openapi.models.parameters.Parameter
- See Also:
Parameter.getExample()
-
setExample
public void setExample(Object example)
- Specified by:
setExample
in interfaceorg.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 interfaceorg.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 interfaceorg.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 interfaceorg.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 interfaceorg.eclipse.microprofile.openapi.models.parameters.Parameter
- See Also:
Parameter.setIn(org.eclipse.microprofile.openapi.models.parameters.Parameter.In)
-
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)
-
-