Package io.openapiparser.model.v31

Class Header

java.lang.Object

io.openapiparser.Properties

io.openapiparser.model.v31.Header

All Implemented Interfaces:

Extensions, Reference

public class Header
extends Properties
implements Reference, Extensions

the Header object.

See specification: 4.8.21 Header Object

Field Summary

Fields inherited from class io.openapiparser.Properties

bucket, context

Constructor Summary

Constructors

Constructor	Description
Header(Context context, io.openapiprocessor.jsonschema.schema.Bucket bucket)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	getAllowEmptyValue()
java.lang.Boolean	getAllowReserved()
java.util.Map<java.lang.String,MediaType>	getContent()
java.lang.Boolean	getDeprecated()
@Nullable java.lang.String	getDescription()
@Nullable java.lang.Object	getExample()
java.util.Map<java.lang.String,Example>	getExamples()
java.lang.Boolean	getExplode()
java.util.Map<java.lang.String,java.lang.Object>	getExtensions()	map of all extension properties.
java.lang.String	getRef()	$ref value.
java.lang.Boolean	getRequired()
@Nullable Schema	getSchema()
java.lang.String	getStyle()
@Nullable java.lang.String	getSummary()
boolean	isRef()	check if this is a $ref object.

Methods inherited from class io.openapiparser.Properties

getBooleanOrDefault, getBooleanOrFalse, getBooleanOrNull, getIntegerOrDefault, getIntegerOrNull, getMapObjectsOrEmpty, getMapObjectsOrEmpty, getMapSetStringsOrEmpty, getMapStringsOrEmpty, getNumberOrNull, getObjectOrNull, getObjectOrThrow, getObjectsOrEmpty, getRawValue, getRawValueOf, getRefObject, getRefObjectOrThrow, getStringOrNull, getStringOrThrow, getStringsOrEmpty, getStringsOrNull, getValueOf, hasProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Header

public Header(Context context,
              io.openapiprocessor.jsonschema.schema.Bucket bucket)

Method Detail

isRef

public boolean isRef()

check if this is a $ref object.

Specified by:

isRef in interface Reference

Returns:

true if $ref else false.

getRef

public java.lang.String getRef()

$ref value. Should be guarded by Reference.isRef(). Throws if Reference.isRef() is false.

Specified by:

getRef in interface Reference

Returns:

ref

getSummary

public @Nullable java.lang.String getSummary()

Specified by:

getSummary in interface Reference

getDescription

public @Nullable java.lang.String getDescription()

Specified by:

getDescription in interface Reference

getRequired

public java.lang.Boolean getRequired()

getDeprecated

public java.lang.Boolean getDeprecated()

getAllowEmptyValue

public java.lang.Boolean getAllowEmptyValue()

getStyle

public java.lang.String getStyle()

getExplode

public java.lang.Boolean getExplode()

getAllowReserved

public java.lang.Boolean getAllowReserved()

getSchema

public @Nullable Schema getSchema()

getExample

public @Nullable java.lang.Object getExample()

getExamples

public java.util.Map<java.lang.String,Example> getExamples()

getContent

public java.util.Map<java.lang.String,MediaType> getContent()

getExtensions

public java.util.Map<java.lang.String,java.lang.Object> getExtensions()

Description copied from interface: Extensions

map of all extension properties.

Specified by:

getExtensions in interface Extensions

Overrides:

getExtensions in class Properties

Returns:

map of extension properties