@Target(value={})
@Retention(value=RUNTIME)
@Inherited
public @interface Encoding
Modifier and Type | Optional Element and Description |
---|---|
boolean |
allowReserved
Determines whether the encoding instance value SHOULD allow reserved characters, as defined by RFC3986 to be
included without percent-encoding.
|
java.lang.String |
contentType
The Content-Type for encoding a specific property.
|
boolean |
explode
When explode is set to true, property values of type array or object generate separate parameters for each value
of the array, or key-value-pair of the map.
|
Extension[] |
extensions
List of extensions to be added to the
Encoding
model corresponding to the containing annotation. |
Header[] |
headers
An array of headers that corresponds to a map of headers in the encoding model.
|
java.lang.String |
name
The name of this encoding object instance.
|
java.lang.String |
style
Style describes how the encoding value will be serialized depending on the type of the parameter value.
|
public abstract java.lang.String name
public abstract java.lang.String contentType
For example, for binary string - contentType is application/octet-stream, for primitive types - text/plain, for object - application/json. The value can be a specific media type (e.g. application/json), a wildcard media type (e.g. image/*), or a comma-separated list of the two types.
public abstract java.lang.String style
Default values include: form, spaceDelimited, pipeDelimited, and deepObject.
public abstract boolean explode
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.public abstract boolean allowReserved
See RFC3986 for full definition of reserved characters.
public abstract Header[] headers
For example, Content-Disposition.
Content-Type is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a multipart.