Package org.eclipse.microprofile.openapi.models.media

Interface Encoding

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  Encoding.Style  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Encoding allowReserved​(java.lang.Boolean allowReserved)
      AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.
      Encoding contentType​(java.lang.String contentType)
      The Content-Type for encoding a specific property.
      Encoding explode​(java.lang.Boolean explode)
      When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map.
      java.lang.Boolean getAllowReserved​()
      AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.
      java.lang.String getContentType​()
      The Content-Type for encoding a specific property.
      java.lang.Boolean getExplode​()
      When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map.
      java.util.Map<java.lang.String,Header> getHeaders​()
      Headers property of an Encoding is a map that allows additional information to be provided as headers
      Encoding.Style getStyle​()
      Style describes how the encoding value will be serialized depending on the type of the parameter value.
      Encoding headers​(java.util.Map<java.lang.String,Header> headers)
      Headers property of an Encoding is a map that allows additional information to be provided as headers
      void setAllowReserved​(java.lang.Boolean allowReserved)
      AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.
      void setContentType​(java.lang.String contentType)
      The Content-Type for encoding a specific property.
      void setExplode​(java.lang.Boolean explode)
      When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map.
      void setHeaders​(java.util.Map<java.lang.String,Header> headers)
      Headers property of an Encoding is a map that allows additional information to be provided as headers
      void setStyle​(Encoding.Style style)
      Style describes how the encoding value will be serialized depending on the type of the parameter value.
      Encoding style​(Encoding.Style style)
      Style describes how the encoding value will be serialized depending on the type of the parameter value.

    • Method Detail

      • contentType

        Encoding contentType​(java.lang.String contentType)
        The Content-Type for encoding a specific property. Default value depends on the property type: i.e. for binary string - contentType is application/octet-stream, for primitive types - text/plain, for object - application/json.

        This method sets contentType property for the Encoding instance to the passed parameter and returns the modified instance

        Parameters:
        contentType - a string that describes the type of content of the encoding
        Returns:
        Encoding

      • getContentType

        java.lang.String getContentType​()
        The Content-Type for encoding a specific property. Default value depends on the property type: i.e. for binary string - contentType is application/octet-stream, for primitive types - text/plain, for object - application/json.

        This method returns the contentType property from an Encoding instance.

        Returns:
        String contentType

      • setContentType

        void setContentType​(java.lang.String contentType)
        The Content-Type for encoding a specific property. Default value depends on the property type: i.e. for binary string - contentType is application/octet-stream, for primitive types - text/plain, for object - application/json.

        This method sets thecontentType property of an Encoding instance to the passed contentType parameter.

        Parameters:
        contentType - a string that describes the type of content of the encoding

      • headers

        Encoding headers​(java.util.Map<java.lang.String,Header> headers)
        Headers property of an Encoding is a map that allows additional information to be provided as headers

        This method sets the headers property of Encoding instance to the passed headers argument and returns the modified instance.

        Parameters:
        headers - a map of name to corresponding header object
        Returns:
        Encoding

      • getHeaders

        java.util.Map<java.lang.String,Header> getHeaders​()
        Headers property of an Encoding is a map that allows additional information to be provided as headers

        This method returns the headers property from a Encoding instance.

        Returns:
        Map<String, Header> headers

      • setHeaders

        void setHeaders​(java.util.Map<java.lang.String,Header> headers)
        Headers property of an Encoding is a map that allows additional information to be provided as headers

        This method sets the headers property of Encoding instance to the passed headers argument.

        Parameters:
        headers - a map of name to corresponding header object

      • style

        Encoding style​(Encoding.Style style)
        Style describes how the encoding value will be serialized depending on the type of the parameter value.

        This method sets the style property of Encoding instance to the passed style argument and returns the modified instance

        Parameters:
        style - a string that descibes how encoding value will be serialized
        Returns:
        Encoding

      • getStyle

        Encoding.Style getStyle​()
        Style describes how the encoding value will be serialized depending on the type of the parameter value.

        This method returns the style property from a Encoding instance.

        Returns:
        String style

      • setStyle

        void setStyle​(Encoding.Style style)
        Style describes how the encoding value will be serialized depending on the type of the parameter value.

        This method sets the style property of Encoding instance to the given style argument.

        Parameters:
        style - a string that descibes how encoding value will be serialized

      • explode

        Encoding explode​(java.lang.Boolean explode)
        When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.

        This method sets the explode property of Encoding instance to the given explode argument and returns the instance.

        Parameters:
        explode - a boolean that indicates whether the property values of array or object will generate separate parameters
        Returns:
        Encoding

      • getExplode

        java.lang.Boolean getExplode​()
        When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.

        This method returns the explode property from a Encoding instance.

        Returns:
        Boolean explode

      • setExplode

        void setExplode​(java.lang.Boolean explode)
        When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.

        This method sets the explode property of Encoding instance to the given explode argument.

        Parameters:
        explode - a boolean that indicates whether the property values of array or object will generate separate parameters

      • allowReserved

        Encoding allowReserved​(java.lang.Boolean allowReserved)
        AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.

        This method sets the allowReserved property of Encoding instance to the given allowReserved argument and returns the instance.

        Parameters:
        allowReserved - a boolean that determines whether the parameter value SHOULD allow reserved characters
        Returns:
        Encoding

      • getAllowReserved

        java.lang.Boolean getAllowReserved​()
        AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.

        This method returns the allowReserved property from a Encoding instance.

        Returns:
        Boolean allowReserved

      • setAllowReserved

        void setAllowReserved​(java.lang.Boolean allowReserved)
        AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.

        This method sets the allowReserved property to the given allowReserved argument.

        Parameters:
        allowReserved - a boolean that determines whether the parameter value SHOULD allow reserved characters