Package com.networknt.oas.model.impl

Class HeaderImpl

java.lang.Object

com.networknt.jsonoverlay.JsonOverlay<V>

com.networknt.jsonoverlay.PropertiesOverlay<Header>

com.networknt.oas.model.impl.HeaderImpl

All Implemented Interfaces:

com.networknt.jsonoverlay.IJsonOverlay<Header>, com.networknt.jsonoverlay.IModelPart<OpenApi3,Header>, Header

public class HeaderImpl
extends com.networknt.jsonoverlay.PropertiesOverlay<Header>
implements Header

Nested Class Summary

Nested classes/interfaces inherited from class com.networknt.jsonoverlay.PropertiesOverlay

com.networknt.jsonoverlay.PropertiesOverlay.PropertyLocator

Field Summary

Fields

Modifier and Type	Field	Description
static String	F_allowEmptyValue
static String	F_allowReserved
static String	F_contentMediaTypes
static String	F_deprecated
static String	F_description
static String	F_example
static String	F_examples
static String	F_explode
static String	F_extensions
static String	F_required
static String	F_schema
static String	F_style
static com.networknt.jsonoverlay.OverlayFactory<Header>	factory

Fields inherited from class com.networknt.jsonoverlay.JsonOverlay

json, mapper, parent, refMgr, value

Constructor Summary

Constructors

Constructor	Description
HeaderImpl(com.fasterxml.jackson.databind.JsonNode json, com.networknt.jsonoverlay.JsonOverlay<?> parent, com.networknt.jsonoverlay.ReferenceManager refMgr)
HeaderImpl(Header header, com.networknt.jsonoverlay.JsonOverlay<?> parent, com.networknt.jsonoverlay.ReferenceManager refMgr)

Method Summary

Modifier and Type	Method	Description
protected void	_elaborateJson()
protected com.networknt.jsonoverlay.OverlayFactory<?>	_getFactory()
Class<?>	_getModelType()
static <OV extends com.networknt.jsonoverlay.IJsonOverlay<?>> com.networknt.jsonoverlay.Builder<Header>	builder(OV modelMember)
static <OV extends com.networknt.jsonoverlay.IJsonOverlay<?>> Header	create(OV modelMember)
Boolean	getAllowEmptyValue()
Boolean	getAllowReserved()
MediaType	getContentMediaType(String name)
Map<String,MediaType>	getContentMediaTypes()
Map<String,MediaType>	getContentMediaTypes(boolean elaborate)
Boolean	getDeprecated()
String	getDescription()
Object	getExample()
Example	getExample(String name)
Map<String,Example>	getExamples()
Map<String,Example>	getExamples(boolean elaborate)
Boolean	getExplode()
Object	getExtension(String name)
Map<String,Object>	getExtensions()
Map<String,Object>	getExtensions(boolean elaborate)
String	getKey()
Boolean	getRequired()
Schema	getSchema()
Schema	getSchema(boolean elaborate)
String	getStyle()
boolean	hasContentMediaType(String name)
boolean	hasContentMediaTypes()
boolean	hasExample(String name)
boolean	hasExamples()
boolean	hasExtension(String name)
boolean	hasExtensions()
boolean	isAllowEmptyValue()
boolean	isAllowReserved()
boolean	isDeprecated()
boolean	isExplode()
boolean	isRequired()
void	removeContentMediaType(String name)
void	removeExample(String name)
void	removeExtension(String name)
void	setAllowEmptyValue(Boolean allowEmptyValue)
void	setAllowReserved(Boolean allowReserved)
void	setContentMediaType(String name, MediaType contentMediaType)
void	setContentMediaTypes(Map<String,MediaType> contentMediaTypes)
void	setDeprecated(Boolean deprecated)
void	setDescription(String description)
void	setExample(Object example)
void	setExample(String name, Example example)
void	setExamples(Map<String,Example> examples)
void	setExplode(Boolean explode)
void	setExtension(String name, Object extension)
void	setExtensions(Map<String,Object> extensions)
void	setRequired(Boolean required)
void	setSchema(Schema schema)
void	setStyle(String style)

Methods inherited from class com.networknt.jsonoverlay.PropertiesOverlay

_add, _createList, _createMap, _createScalar, _elaborate, _findInternal, _fixJson, _fromJson, _get, _get, _get, _get, _get, _get, _getList, _getList, _getMap, _getMap, _getOverlay, _insert, _isElaborated, _isPresent, _remove, _remove, _set, _set, _setList, _setMap, _setScalar, _toJsonInternal, equals, equals, hashCode

Methods inherited from class com.networknt.jsonoverlay.JsonOverlay

_ensureElaborated, _getCreatingRef, _jsonArray, _jsonBoolean, _jsonMissing, _jsonNull, _jsonObject, _jsonScalar, _jsonScalar, _jsonScalar, _jsonScalar, _jsonScalar, _jsonScalar, _jsonScalar, _jsonScalar, _jsonScalar, _setCreatingRef, _setParent, builder, create, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

F_description

public static final String F_description

See Also:

Constant Field Values

F_required

public static final String F_required

See Also:

Constant Field Values

F_deprecated

public static final String F_deprecated

See Also:

Constant Field Values

F_allowEmptyValue

public static final String F_allowEmptyValue

See Also:

Constant Field Values

F_style

public static final String F_style

See Also:

Constant Field Values

F_explode

public static final String F_explode

See Also:

Constant Field Values

F_allowReserved

public static final String F_allowReserved

See Also:

Constant Field Values

F_schema

public static final String F_schema

See Also:

Constant Field Values

F_example

public static final String F_example

See Also:

Constant Field Values

F_examples

public static final String F_examples

See Also:

Constant Field Values

F_contentMediaTypes

public static final String F_contentMediaTypes

See Also:

Constant Field Values

F_extensions

public static final String F_extensions

See Also:

Constant Field Values

factory

public static com.networknt.jsonoverlay.OverlayFactory<Header> factory

Constructor Detail

HeaderImpl

public HeaderImpl(com.fasterxml.jackson.databind.JsonNode json,
                  com.networknt.jsonoverlay.JsonOverlay<?> parent,
                  com.networknt.jsonoverlay.ReferenceManager refMgr)

HeaderImpl

public HeaderImpl(Header header,
                  com.networknt.jsonoverlay.JsonOverlay<?> parent,
                  com.networknt.jsonoverlay.ReferenceManager refMgr)

Method Detail

getKey

public String getKey()

Specified by:

getKey in interface Header

getDescription

public String getDescription()

Specified by:

getDescription in interface Header

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface Header

getRequired

public Boolean getRequired()

Specified by:

getRequired in interface Header

isRequired

public boolean isRequired()

Specified by:

isRequired in interface Header

setRequired

public void setRequired(Boolean required)

Specified by:

setRequired in interface Header

getDeprecated

public Boolean getDeprecated()

Specified by:

getDeprecated in interface Header

isDeprecated

public boolean isDeprecated()

Specified by:

isDeprecated in interface Header

setDeprecated

public void setDeprecated(Boolean deprecated)

Specified by:

setDeprecated in interface Header

getAllowEmptyValue

public Boolean getAllowEmptyValue()

Specified by:

getAllowEmptyValue in interface Header

isAllowEmptyValue

public boolean isAllowEmptyValue()

Specified by:

isAllowEmptyValue in interface Header

setAllowEmptyValue

public void setAllowEmptyValue(Boolean allowEmptyValue)

Specified by:

setAllowEmptyValue in interface Header

getStyle

public String getStyle()

Specified by:

getStyle in interface Header

setStyle

public void setStyle(String style)

Specified by:

setStyle in interface Header

getExplode

public Boolean getExplode()

Specified by:

getExplode in interface Header

isExplode

public boolean isExplode()

Specified by:

isExplode in interface Header

setExplode

public void setExplode(Boolean explode)

Specified by:

setExplode in interface Header

getAllowReserved

public Boolean getAllowReserved()

Specified by:

getAllowReserved in interface Header

isAllowReserved

public boolean isAllowReserved()

Specified by:

isAllowReserved in interface Header

setAllowReserved

public void setAllowReserved(Boolean allowReserved)

Specified by:

setAllowReserved in interface Header

getSchema

public Schema getSchema()

Specified by:

getSchema in interface Header

getSchema

public Schema getSchema(boolean elaborate)

Specified by:

getSchema in interface Header

setSchema

public void setSchema(Schema schema)

Specified by:

setSchema in interface Header

getExample

public Object getExample()

Specified by:

getExample in interface Header

setExample

public void setExample(Object example)

Specified by:

setExample in interface Header

getExamples

public Map<String,Example> getExamples()

Specified by:

getExamples in interface Header

getExamples

public Map<String,Example> getExamples(boolean elaborate)

Specified by:

getExamples in interface Header

hasExamples

public boolean hasExamples()

Specified by:

hasExamples in interface Header

hasExample

public boolean hasExample(String name)

Specified by:

hasExample in interface Header

getExample

public Example getExample(String name)

Specified by:

getExample in interface Header

setExamples

public void setExamples(Map<String,Example> examples)

Specified by:

setExamples in interface Header

setExample

public void setExample(String name,
                       Example example)

Specified by:

setExample in interface Header

removeExample

public void removeExample(String name)

Specified by:

removeExample in interface Header

getContentMediaTypes

public Map<String,MediaType> getContentMediaTypes()

Specified by:

getContentMediaTypes in interface Header

getContentMediaTypes

public Map<String,MediaType> getContentMediaTypes(boolean elaborate)

Specified by:

getContentMediaTypes in interface Header

hasContentMediaTypes

public boolean hasContentMediaTypes()

Specified by:

hasContentMediaTypes in interface Header

hasContentMediaType

public boolean hasContentMediaType(String name)

Specified by:

hasContentMediaType in interface Header

getContentMediaType

public MediaType getContentMediaType(String name)

Specified by:

getContentMediaType in interface Header

setContentMediaTypes

public void setContentMediaTypes(Map<String,MediaType> contentMediaTypes)

Specified by:

setContentMediaTypes in interface Header

setContentMediaType

public void setContentMediaType(String name,
                                MediaType contentMediaType)

Specified by:

setContentMediaType in interface Header

removeContentMediaType

public void removeContentMediaType(String name)

Specified by:

removeContentMediaType in interface Header

getExtensions

public Map<String,Object> getExtensions()

Specified by:

getExtensions in interface Header

getExtensions

public Map<String,Object> getExtensions(boolean elaborate)

Specified by:

getExtensions in interface Header

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface Header

hasExtension

public boolean hasExtension(String name)

Specified by:

hasExtension in interface Header

getExtension

public Object getExtension(String name)

Specified by:

getExtension in interface Header

setExtensions

public void setExtensions(Map<String,Object> extensions)

Specified by:

setExtensions in interface Header

setExtension

public void setExtension(String name,
                         Object extension)

Specified by:

setExtension in interface Header

removeExtension

public void removeExtension(String name)

Specified by:

removeExtension in interface Header

_elaborateJson

protected void _elaborateJson()

Overrides:

_elaborateJson in class com.networknt.jsonoverlay.PropertiesOverlay<Header>

_getModelType

public Class<?> _getModelType()

Overrides:

_getModelType in class com.networknt.jsonoverlay.JsonOverlay<Header>

_getFactory

protected com.networknt.jsonoverlay.OverlayFactory<?> _getFactory()

Specified by:

_getFactory in class com.networknt.jsonoverlay.JsonOverlay<Header>

builder

public static <OV extends com.networknt.jsonoverlay.IJsonOverlay<?>> com.networknt.jsonoverlay.Builder<Header> builder(OV modelMember)

create

public static <OV extends com.networknt.jsonoverlay.IJsonOverlay<?>> Header create(OV modelMember)