io.smallrye.openapi.api.models.headers

Class HeaderImpl

java.lang.Object

io.smallrye.openapi.api.models.ExtensibleImpl<org.eclipse.microprofile.openapi.models.headers.Header>

io.smallrye.openapi.api.models.headers.HeaderImpl

All Implemented Interfaces:

ModelImpl, org.eclipse.microprofile.openapi.models.Constructible, org.eclipse.microprofile.openapi.models.Extensible<org.eclipse.microprofile.openapi.models.headers.Header>, org.eclipse.microprofile.openapi.models.headers.Header, org.eclipse.microprofile.openapi.models.Reference<org.eclipse.microprofile.openapi.models.headers.Header>

public class HeaderImpl
extends ExtensibleImpl<org.eclipse.microprofile.openapi.models.headers.Header>
implements org.eclipse.microprofile.openapi.models.headers.Header, ModelImpl

An implementation of the Header OpenAPI model interface.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.microprofile.openapi.models.headers.Header

org.eclipse.microprofile.openapi.models.headers.Header.Style

Constructor Summary

Constructors

Constructor and Description
HeaderImpl()

Method Summary

Modifier and Type	Method and Description
org.eclipse.microprofile.openapi.models.headers.Header	addExample(String key, org.eclipse.microprofile.openapi.models.examples.Example example)
org.eclipse.microprofile.openapi.models.headers.Header	allowEmptyValue(Boolean allowEmptyValue)
org.eclipse.microprofile.openapi.models.headers.Header	content(org.eclipse.microprofile.openapi.models.media.Content content)
org.eclipse.microprofile.openapi.models.headers.Header	deprecated(Boolean deprecated)
org.eclipse.microprofile.openapi.models.headers.Header	description(String description)
org.eclipse.microprofile.openapi.models.headers.Header	example(Object example)
org.eclipse.microprofile.openapi.models.headers.Header	examples(Map<String,org.eclipse.microprofile.openapi.models.examples.Example> examples)
org.eclipse.microprofile.openapi.models.headers.Header	explode(Boolean explode)
Boolean	getAllowEmptyValue()
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()
String	getRef()
Boolean	getRequired()
org.eclipse.microprofile.openapi.models.media.Schema	getSchema()
org.eclipse.microprofile.openapi.models.headers.Header.Style	getStyle()
org.eclipse.microprofile.openapi.models.headers.Header	ref(String ref)
void	removeExample(String key)
org.eclipse.microprofile.openapi.models.headers.Header	required(Boolean required)
org.eclipse.microprofile.openapi.models.headers.Header	schema(org.eclipse.microprofile.openapi.models.media.Schema schema)
void	setAllowEmptyValue(Boolean allowEmptyValue)
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	setRef(String ref)
void	setRequired(Boolean required)
void	setSchema(org.eclipse.microprofile.openapi.models.media.Schema schema)
void	setStyle(org.eclipse.microprofile.openapi.models.headers.Header.Style style)
org.eclipse.microprofile.openapi.models.headers.Header	style(org.eclipse.microprofile.openapi.models.headers.Header.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

Constructor Detail

HeaderImpl

public HeaderImpl()

Method Detail

getRef

public String getRef()

Specified by:

getRef in interface org.eclipse.microprofile.openapi.models.Reference<org.eclipse.microprofile.openapi.models.headers.Header>

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.headers.Header>

See Also:

Reference.setRef(java.lang.String)

ref

public org.eclipse.microprofile.openapi.models.headers.Header ref(String ref)

Specified by:

ref in interface org.eclipse.microprofile.openapi.models.Reference<org.eclipse.microprofile.openapi.models.headers.Header>

See Also:

Reference.ref(java.lang.String)

getDescription

public String getDescription()

Specified by:

getDescription in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.getDescription()

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.setDescription(java.lang.String)

description

public org.eclipse.microprofile.openapi.models.headers.Header description(String description)

Specified by:

description in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.description(java.lang.String)

getRequired

public Boolean getRequired()

Specified by:

getRequired in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.getRequired()

setRequired

public void setRequired(Boolean required)

Specified by:

setRequired in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.setRequired(java.lang.Boolean)

required

public org.eclipse.microprofile.openapi.models.headers.Header required(Boolean required)

Specified by:

required in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.required(java.lang.Boolean)

getDeprecated

public Boolean getDeprecated()

Specified by:

getDeprecated in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.getDeprecated()

setDeprecated

public void setDeprecated(Boolean deprecated)

Specified by:

setDeprecated in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.setDeprecated(java.lang.Boolean)

deprecated

public org.eclipse.microprofile.openapi.models.headers.Header deprecated(Boolean deprecated)

Specified by:

deprecated in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.deprecated(java.lang.Boolean)

getAllowEmptyValue

public Boolean getAllowEmptyValue()

Specified by:

getAllowEmptyValue in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.getAllowEmptyValue()

setAllowEmptyValue

public void setAllowEmptyValue(Boolean allowEmptyValue)

Specified by:

setAllowEmptyValue in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.setAllowEmptyValue(java.lang.Boolean)

allowEmptyValue

public org.eclipse.microprofile.openapi.models.headers.Header allowEmptyValue(Boolean allowEmptyValue)

Specified by:

allowEmptyValue in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.allowEmptyValue(java.lang.Boolean)

getStyle

public org.eclipse.microprofile.openapi.models.headers.Header.Style getStyle()

Specified by:

getStyle in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.getStyle()

setStyle

public void setStyle(org.eclipse.microprofile.openapi.models.headers.Header.Style style)

Specified by:

setStyle in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.setStyle(org.eclipse.microprofile.openapi.models.headers.Header.Style)

style

public org.eclipse.microprofile.openapi.models.headers.Header style(org.eclipse.microprofile.openapi.models.headers.Header.Style style)

Specified by:

style in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.style(org.eclipse.microprofile.openapi.models.headers.Header.Style)

getExplode

public Boolean getExplode()

Specified by:

getExplode in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.getExplode()

setExplode

public void setExplode(Boolean explode)

Specified by:

setExplode in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.setExplode(java.lang.Boolean)

explode

public org.eclipse.microprofile.openapi.models.headers.Header explode(Boolean explode)

Specified by:

explode in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.explode(java.lang.Boolean)

getSchema

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

Specified by:

getSchema in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.getSchema()

setSchema

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

Specified by:

setSchema in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.setSchema(org.eclipse.microprofile.openapi.models.media.Schema)

schema

public org.eclipse.microprofile.openapi.models.headers.Header schema(org.eclipse.microprofile.openapi.models.media.Schema schema)

Specified by:

schema in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.schema(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.headers.Header

See Also:

Header.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.headers.Header

See Also:

Header.setExamples(java.util.Map)

examples

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

Specified by:

examples in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.examples(java.util.Map)

addExample

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

Specified by:

addExample in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.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.headers.Header

See Also:

Header.removeExample(java.lang.String)

getExample

public Object getExample()

Specified by:

getExample in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.getExample()

setExample

public void setExample(Object example)

Specified by:

setExample in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.setExample(java.lang.Object)

example

public org.eclipse.microprofile.openapi.models.headers.Header example(Object example)

Specified by:

example in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.example(java.lang.Object)

getContent

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

Specified by:

getContent in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.getContent()

setContent

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

Specified by:

setContent in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.setContent(org.eclipse.microprofile.openapi.models.media.Content)

content

public org.eclipse.microprofile.openapi.models.headers.Header content(org.eclipse.microprofile.openapi.models.media.Content content)

Specified by:

content in interface org.eclipse.microprofile.openapi.models.headers.Header

See Also:

Header.content(org.eclipse.microprofile.openapi.models.media.Content)