Package 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.

  • Constructor Details

    • HeaderImpl

      public HeaderImpl()

  • Method Details

    • 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)

    • 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)

    • 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)

    • 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)

    • 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)

    • 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)

    • 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)

    • 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)

    • 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)

    • 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)

    • 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)