Package fish.payara.microprofile.openapi.impl.model.headers

Class HeaderImpl

java.lang.Object

fish.payara.microprofile.openapi.impl.model.ExtensibleImpl<org.eclipse.microprofile.openapi.models.headers.Header>

fish.payara.microprofile.openapi.impl.model.headers.HeaderImpl

All Implemented Interfaces:

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

Nested Class Summary

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

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

Field Summary

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

extensions

Constructor Summary

Constructors

Constructor	Description
HeaderImpl()

Method Summary

Modifier and Type	Method	Description
org.eclipse.microprofile.openapi.models.headers.Header	addExample(String key, org.eclipse.microprofile.openapi.models.examples.Example examplesItem)
static org.eclipse.microprofile.openapi.models.headers.Header	createInstance(org.glassfish.hk2.classmodel.reflect.AnnotationModel annotation, ApiContext context)
static Map<String,org.eclipse.microprofile.openapi.models.headers.Header>	createInstances(org.glassfish.hk2.classmodel.reflect.AnnotationModel annotation, ApiContext context)
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()
static void	merge(String headerName, org.eclipse.microprofile.openapi.models.headers.Header header, Map<String,org.eclipse.microprofile.openapi.models.headers.Header> headers, boolean override, ApiContext context)
static void	merge(org.eclipse.microprofile.openapi.models.headers.Header from, org.eclipse.microprofile.openapi.models.headers.Header to, boolean override, ApiContext context)
void	removeExample(String key)
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)

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

addExtension, convertExtensionValue, extensionName, getExtensions, merge, removeExtension, setExtensions, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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.headers.Header

allowEmptyValue, content, deprecated, description, example, examples, explode, required, schema, style

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

ref

Constructor Detail

HeaderImpl

public HeaderImpl()

Method Detail

createInstances

public static Map<String,org.eclipse.microprofile.openapi.models.headers.Header> createInstances(org.glassfish.hk2.classmodel.reflect.AnnotationModel annotation,
                                                                                                       ApiContext context)

createInstance

public static org.eclipse.microprofile.openapi.models.headers.Header createInstance(org.glassfish.hk2.classmodel.reflect.AnnotationModel annotation,
                                                                                    ApiContext context)

getRef

public String getRef()

Specified by:

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

setRef

public void setRef(String ref)

Specified by:

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

getDescription

public String getDescription()

Specified by:

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

setDescription

public void setDescription(String description)

Specified by:

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

getRequired

public Boolean getRequired()

Specified by:

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

setRequired

public void setRequired(Boolean required)

Specified by:

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

getDeprecated

public Boolean getDeprecated()

Specified by:

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

setDeprecated

public void setDeprecated(Boolean deprecated)

Specified by:

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

getAllowEmptyValue

public Boolean getAllowEmptyValue()

Specified by:

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

setAllowEmptyValue

public void setAllowEmptyValue(Boolean allowEmptyValue)

Specified by:

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

getStyle

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

Specified by:

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

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

getExplode

public Boolean getExplode()

Specified by:

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

setExplode

public void setExplode(Boolean explode)

Specified by:

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

getSchema

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

Specified by:

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

setSchema

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

Specified by:

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

getExamples

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

Specified by:

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

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

addExample

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

Specified by:

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

removeExample

public void removeExample(String key)

Specified by:

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

getExample

public Object getExample()

Specified by:

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

setExample

public void setExample(Object example)

Specified by:

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

getContent

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

Specified by:

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

setContent

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

Specified by:

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

merge

public static void merge(org.eclipse.microprofile.openapi.models.headers.Header from,
                         org.eclipse.microprofile.openapi.models.headers.Header to,
                         boolean override,
                         ApiContext context)

merge

public static void merge(String headerName,
                         org.eclipse.microprofile.openapi.models.headers.Header header,
                         Map<String,org.eclipse.microprofile.openapi.models.headers.Header> headers,
                         boolean override,
                         ApiContext context)