Package io.smallrye.openapi.internal.models.headers

Class Header

java.lang.Object
io.smallrye.openapi.model.BaseModel<org.eclipse.microprofile.openapi.models.headers.Header>
io.smallrye.openapi.model.BaseExtensibleModel<org.eclipse.microprofile.openapi.models.headers.Header>
io.smallrye.openapi.internal.models.headers.Header
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>
Direct Known Subclasses:
HeaderImpl
@Generated(value="io.smallrye.openapi.model.apt.SmallRyeModelProcessor", date="2026-01-25T12:11:29.567111809Z") public class Header extends io.smallrye.openapi.model.BaseExtensibleModel<org.eclipse.microprofile.openapi.models.headers.Header> implements org.eclipse.microprofile.openapi.models.headers.Header

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    Header.Properties
     

    Nested classes/interfaces inherited from class io.smallrye.openapi.model.BaseModel

    io.smallrye.openapi.model.BaseModel.MergeDirective

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

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final io.smallrye.openapi.model.PropertyMetadata
    PROPERTIES
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Header()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Header
    addExample(String newKey, org.eclipse.microprofile.openapi.models.examples.Example newValue)
    protected org.eclipse.microprofile.openapi.models.headers.Header
    filter(org.eclipse.microprofile.openapi.OASFilter filter)
    Boolean
    getAllowEmptyValue()
    org.eclipse.microprofile.openapi.models.media.Content
    getContent()
    Boolean
    getDeprecated()
    Object
    getExample()
    Map<String,org.eclipse.microprofile.openapi.models.examples.Example>
    getExamples()
    Boolean
    getExplode()
    io.smallrye.openapi.model.PropertyMetadata
    getPropertyMetadata()
     
    Boolean
    getRequired()
    org.eclipse.microprofile.openapi.models.media.Schema
    getSchema()
    org.eclipse.microprofile.openapi.models.headers.Header.Style
    getStyle()
    void
    removeExample(String key)
    void
    setAllowEmptyValue(Boolean newValue)
    void
    setContent(org.eclipse.microprofile.openapi.models.media.Content newValue)
    void
    setDeprecated(Boolean newValue)
    void
    setExample(Object newValue)
    void
    setExamples(Map<String,org.eclipse.microprofile.openapi.models.examples.Example> newValue)
    void
    setExplode(Boolean newValue)
    void
    setRequired(Boolean newValue)
    void
    setSchema(org.eclipse.microprofile.openapi.models.media.Schema newValue)
    void
    setStyle(org.eclipse.microprofile.openapi.models.headers.Header.Style newValue)

    Methods inherited from class io.smallrye.openapi.model.BaseExtensibleModel

    addExtension, addListPropertyEntry, equals, getAllExtensions, getAllProperties, getExtension, getExtensions, getListProperty, getMapProperty, getProperty, getProperty, hasExtension, hashCode, isExtension, merge, putMapPropertyEntry, removeExtension, removeListPropertyEntry, removeMapPropertyEntry, setAllProperties, setExtensions, setListProperty, setMapProperty, setProperty

    Methods inherited from class io.smallrye.openapi.model.BaseModel

    constructible, deepCopy, deepCopy, filter, getDescription, getExternalDocs, getModCount, getName, getProperties, getRef, getSummary, incrementModCount, merge, mergeDirective, setDescription, setExternalDocs, setName, setRef, setSummary, toString

    Methods inherited from class java.lang.Object

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

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

    addExtension, extensions, getExtension, getExtensions, hasExtension, removeExtension, setExtensions

    Methods inherited from interface org.eclipse.microprofile.openapi.models.headers.Header

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

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

    getRef, ref, setRef

  • Field Details

    • PROPERTIES

      public static final io.smallrye.openapi.model.PropertyMetadata PROPERTIES

  • Constructor Details

    • Header

      public Header()

  • Method Details

    • getPropertyMetadata

      public io.smallrye.openapi.model.PropertyMetadata getPropertyMetadata()
      Specified by:
      getPropertyMetadata in class io.smallrye.openapi.model.BaseModel<org.eclipse.microprofile.openapi.models.headers.Header>

    • filter

      protected org.eclipse.microprofile.openapi.models.headers.Header filter(org.eclipse.microprofile.openapi.OASFilter filter)
      Overrides:
      filter in class io.smallrye.openapi.model.BaseModel<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 newValue)
      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 newValue)
      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 newValue)
      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 newValue)
      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 newValue)
      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 newValue)
      Specified by:
      setSchema 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 newValue)
      Specified by:
      setExample 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> newValue)
      Specified by:
      setExamples in interface org.eclipse.microprofile.openapi.models.headers.Header

    • addExample

      public Header addExample(String newKey, org.eclipse.microprofile.openapi.models.examples.Example newValue)
      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

    • 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 newValue)
      Specified by:
      setContent in interface org.eclipse.microprofile.openapi.models.headers.Header