All Superinterfaces:

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

All Known Implementing Classes:

HeaderImpl
```
public interface Header
extends com.networknt.jsonoverlay.IJsonOverlay<Header>, com.networknt.jsonoverlay.IModelPart<OpenApi3,Header>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`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)`

Method Detail

getKey
```
String getKey()
```

getDescription
```
String getDescription()
```

setDescription

void setDescription(String description)

getRequired
```
Boolean getRequired()
```

isRequired
```
boolean isRequired()
```

setRequired
```
void setRequired(Boolean required)
```

getDeprecated
```
Boolean getDeprecated()
```

isDeprecated
```
boolean isDeprecated()
```

setDeprecated

void setDeprecated(Boolean deprecated)

getAllowEmptyValue
```
Boolean getAllowEmptyValue()
```

isAllowEmptyValue
```
boolean isAllowEmptyValue()
```

setAllowEmptyValue

void setAllowEmptyValue(Boolean allowEmptyValue)

getStyle
```
String getStyle()
```

setStyle
```
void setStyle(String style)
```

getExplode
```
Boolean getExplode()
```

isExplode
```
boolean isExplode()
```

setExplode
```
void setExplode(Boolean explode)
```

getAllowReserved
```
Boolean getAllowReserved()
```

isAllowReserved
```
boolean isAllowReserved()
```

setAllowReserved

void setAllowReserved(Boolean allowReserved)

getSchema
```
Schema getSchema()
```

getSchema

Schema getSchema(boolean elaborate)

setSchema
```
void setSchema(Schema schema)
```

getExample
```
Object getExample()
```

setExample
```
void setExample(Object example)
```

getExamples
```
Map<String,Example> getExamples()
```

getExamples

Map<String,Example> getExamples(boolean elaborate)

hasExamples
```
boolean hasExamples()
```

hasExample
```
boolean hasExample(String name)
```

getExample
```
Example getExample(String name)
```

setExamples

void setExamples(Map<String,Example> examples)

setExample

void setExample(String name,
                Example example)

removeExample
```
void removeExample(String name)
```

getContentMediaTypes

Map<String,MediaType> getContentMediaTypes()

getContentMediaTypes

Map<String,MediaType> getContentMediaTypes(boolean elaborate)

hasContentMediaTypes
```
boolean hasContentMediaTypes()
```

hasContentMediaType

boolean hasContentMediaType(String name)

getContentMediaType

MediaType getContentMediaType(String name)

setContentMediaTypes

void setContentMediaTypes(Map<String,MediaType> contentMediaTypes)

setContentMediaType

void setContentMediaType(String name,
                         MediaType contentMediaType)

removeContentMediaType

void removeContentMediaType(String name)

getExtensions
```
Map<String,Object> getExtensions()
```

getExtensions

Map<String,Object> getExtensions(boolean elaborate)

hasExtensions
```
boolean hasExtensions()
```

hasExtension
```
boolean hasExtension(String name)
```

getExtension
```
Object getExtension(String name)
```

setExtensions

void setExtensions(Map<String,Object> extensions)

setExtension

void setExtension(String name,
                  Object extension)

removeExtension
```
void removeExtension(String name)
```

Interface Header

Method Summary

Method Detail

getKey

getDescription

setDescription

getRequired

isRequired

setRequired

getDeprecated

isDeprecated

setDeprecated

getAllowEmptyValue

isAllowEmptyValue

setAllowEmptyValue

getStyle

setStyle

getExplode

isExplode

setExplode

getAllowReserved

isAllowReserved

setAllowReserved

getSchema

getSchema

setSchema

getExample

setExample

getExamples

getExamples

hasExamples

hasExample

getExample

setExamples

setExample

removeExample

getContentMediaTypes

getContentMediaTypes

hasContentMediaTypes

hasContentMediaType

getContentMediaType

setContentMediaTypes

setContentMediaType

removeContentMediaType

getExtensions

getExtensions

hasExtensions

hasExtension

getExtension

setExtensions

setExtension

removeExtension