MediaType (Helidon Common HTTP 0.10.5 API)

java.lang.Object
- io.helidon.common.http.MediaType

All Implemented Interfaces:

AcceptPredicate<MediaType>, java.util.function.Predicate<MediaType>
```
public class MediaType
extends java.lang.Object
implements AcceptPredicate<MediaType>
```
An abstraction for a media type. Instances are immutable.

See Also:

HTTP/1.1 section 3.7

Field Summary

Fields
Modifier and Type	Field and Description
`static MediaType`	`APPLICATION_ATOM_XML` A `MediaType` constant representing `application/atom+xml` media type.
`static MediaType`	`APPLICATION_FORM_URLENCODED` A `MediaType` constant representing `application/x-www-form-urlencoded` media type.
`static MediaType`	`APPLICATION_JSON` A `MediaType` constant representing `application/json` media type.
`static MediaType`	`APPLICATION_OCTET_STREAM` A `MediaType` constant representing `application/octet-stream` media type.
`static MediaType`	`APPLICATION_SVG_XML` A `MediaType` constant representing `application/svg+xml` media type.
`static MediaType`	`APPLICATION_XHTML_XML` A `MediaType` constant representing `application/xhtml+xml` media type.
`static MediaType`	`APPLICATION_XML` A `MediaType` constant representing `application/xml` media type.
`static java.lang.String`	`CHARSET_PARAMETER` The media type "charset" parameter name.
`static java.util.function.Predicate<MediaType>`	`JSON_PREDICATE` Predicate to test if `MediaType` is `application/json` or has `json` suffix.
`static MediaType`	`MULTIPART_FORM_DATA` A `MediaType` constant representing `multipart/form-data` media type.
`static MediaType`	`TEXT_HTML` A `MediaType` constant representing `text/html` media type.
`static MediaType`	`TEXT_PLAIN` A `MediaType` constant representing `text/plain` media type.
`static MediaType`	`TEXT_XML` A `MediaType` constant representing `text/xml` media type.
`static MediaType`	`WILDCARD` A `MediaType` constant representing wildcard media type.
`static java.util.function.Predicate<MediaType>`	`XML_PREDICATE` Predicate to test if `MediaType` is `application/xml` or `text/xml` or has `xml` suffix.

Fields inherited from interface io.helidon.common.http.AcceptPredicate
QUALITY_FACTOR_PARAMETER, WILDCARD_VALUE

Constructor Summary

Constructors
Constructor and Description
`MediaType()` Creates a new instance of `MediaType`, both type and subtype are wildcards.
`MediaType(java.lang.String type, java.lang.String subtype)` Creates a new instance of `MediaType` with the supplied type and subtype.
`MediaType(java.lang.String type, java.lang.String subtype, java.util.Map<java.lang.String,java.lang.String> parameters)` Creates a new instance of `MediaType` with the supplied type, subtype and parameters.
`MediaType(java.lang.String type, java.lang.String subtype, java.lang.String charset)` Creates a new instance of `MediaType` with the supplied type, subtype and "charset" parameter.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)` Compares `obj` to this media type to see if they are the same by comparing type, subtype and parameters.
`java.util.Optional<java.lang.String>`	`getCharset()` Gets `Optional` value of charset parameter.
`java.util.Map<java.lang.String,java.lang.String>`	`getParameters()` Getter for a read-only parameter map.
`java.lang.String`	`getSubtype()` Getter for subtype.
`java.lang.String`	`getType()` Getter for primary type.
`int`	`hashCode()` Generate a hash code from the type, subtype and parameters.
`boolean`	`hasSuffix(java.lang.String suffix)` Tests if this media type has provided Structured Syntax `suffix` (RFC 6839).
`boolean`	`isWildcardSubtype()` Checks if the subtype is a wildcard.
`boolean`	`isWildcardType()` Checks if the primary type is a wildcard.
`static MediaType`	`parse(java.lang.String input)` Parses a media type from its string representation.
`double`	`qualityFactor()` Gets quality factor parameter ("q") as a double value.
`boolean`	`test(MediaType other)` Check if this media type is compatible with another media type.
`java.lang.String`	`toString()` Convert the media type to a string suitable for use as the value of a corresponding HTTP header.
`MediaType`	`withCharset(java.lang.String charset)` Create a new `MediaType` instance with the same type, subtype and parameters copied from the original instance and the supplied "charset" parameter.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Predicate
and, isEqual, negate, or

- Field Detail
  - CHARSET_PARAMETER
```
public static final java.lang.String CHARSET_PARAMETER
```
    The media type "charset" parameter name.
    
    See Also:
    
    Constant Field Values
  - WILDCARD
```
public static final MediaType WILDCARD
```
    A MediaType constant representing wildcard media type.
  - APPLICATION_XML
```
public static final MediaType APPLICATION_XML
```
    A MediaType constant representing application/xml media type.
  - APPLICATION_ATOM_XML
```
public static final MediaType APPLICATION_ATOM_XML
```
    A MediaType constant representing application/atom+xml media type.
  - APPLICATION_XHTML_XML
```
public static final MediaType APPLICATION_XHTML_XML
```
    A MediaType constant representing application/xhtml+xml media type.
  - APPLICATION_SVG_XML
```
public static final MediaType APPLICATION_SVG_XML
```
    A MediaType constant representing application/svg+xml media type.
  - APPLICATION_JSON
```
public static final MediaType APPLICATION_JSON
```
    A MediaType constant representing application/json media type.
  - APPLICATION_FORM_URLENCODED
```
public static final MediaType APPLICATION_FORM_URLENCODED
```
    A MediaType constant representing application/x-www-form-urlencoded media type.
  - MULTIPART_FORM_DATA
```
public static final MediaType MULTIPART_FORM_DATA
```
    A MediaType constant representing multipart/form-data media type.
  - APPLICATION_OCTET_STREAM
```
public static final MediaType APPLICATION_OCTET_STREAM
```
    A MediaType constant representing application/octet-stream media type.
  - TEXT_PLAIN
```
public static final MediaType TEXT_PLAIN
```
    A MediaType constant representing text/plain media type.
  - TEXT_XML
```
public static final MediaType TEXT_XML
```
    A MediaType constant representing text/xml media type.
  - TEXT_HTML
```
public static final MediaType TEXT_HTML
```
    A MediaType constant representing text/html media type.
  - XML_PREDICATE
```
public static final java.util.function.Predicate<MediaType> XML_PREDICATE
```
    Predicate to test if MediaType is application/xml or text/xml or has xml suffix.
  - JSON_PREDICATE
```
public static final java.util.function.Predicate<MediaType> JSON_PREDICATE
```
    Predicate to test if MediaType is application/json or has json suffix.
- Constructor Detail
  - MediaType
```
public MediaType(java.lang.String type,
                 java.lang.String subtype,
                 java.util.Map<java.lang.String,java.lang.String> parameters)
```
    Creates a new instance of MediaType with the supplied type, subtype and parameters.
    
    Parameters:
    
    type - the primary type, null is equivalent to AcceptPredicate.WILDCARD_VALUE.
    
    subtype - the subtype, null is equivalent to AcceptPredicate.WILDCARD_VALUE.
    
    parameters - a map of media type parameters, null is the same as an empty map.
  - MediaType
```
public MediaType(java.lang.String type,
                 java.lang.String subtype)
```
    Creates a new instance of MediaType with the supplied type and subtype.
    
    Parameters:
    
    type - the primary type, null is equivalent to AcceptPredicate.WILDCARD_VALUE
    
    subtype - the subtype, null is equivalent to AcceptPredicate.WILDCARD_VALUE
  - MediaType
```
public MediaType(java.lang.String type,
                 java.lang.String subtype,
                 java.lang.String charset)
```
    Creates a new instance of MediaType with the supplied type, subtype and "charset" parameter.
    
    Parameters:
    
    type - the primary type, null is equivalent to AcceptPredicate.WILDCARD_VALUE
    
    subtype - the subtype, null is equivalent to AcceptPredicate.WILDCARD_VALUE
    
    charset - the "charset" parameter value. If null or empty the "charset" parameter will not be set.
  - MediaType
```
public MediaType()
```
    Creates a new instance of MediaType, both type and subtype are wildcards. Consider using the constant AcceptPredicate.WILDCARD_VALUE instead.
- Method Detail
  - parse
```
public static MediaType parse(java.lang.String input)
```
    Parses a media type from its string representation.
    
    Parameters:
    
    input - the input string representing a media type
    
    Returns:
    
    parsed MediaType instance
    
    Throws:
    
    java.lang.IllegalArgumentException - if the input is not parsable
    
    java.lang.NullPointerException - if the input is null
  - getType
```
public java.lang.String getType()
```
    Getter for primary type.
    
    Returns:
    
    value of primary type.
  - isWildcardType
```
public boolean isWildcardType()
```
    Checks if the primary type is a wildcard.
    
    Returns:
    
    true if the primary type is a wildcard.
  - getSubtype
```
public java.lang.String getSubtype()
```
    Getter for subtype.
    
    Returns:
    
    value of subtype.
  - isWildcardSubtype
```
public boolean isWildcardSubtype()
```
    Checks if the subtype is a wildcard.
    
    Returns:
    
    true if the subtype is a wildcard.
  - getParameters
```
public java.util.Map<java.lang.String,java.lang.String> getParameters()
```
    Getter for a read-only parameter map. Keys are case-insensitive.
    
    Returns:
    
    an immutable map of parameters.
  - withCharset
```
public MediaType withCharset(java.lang.String charset)
```
    Create a new MediaType instance with the same type, subtype and parameters copied from the original instance and the supplied "charset" parameter.
    
    Parameters:
    
    charset - the "charset" parameter value. If null or empty the "charset" parameter will not be set or updated.
    
    Returns:
    
    copy of the current MediaType instance with the "charset" parameter set to the supplied value.
    
    Since:
    
    2.0
  - getCharset
```
public java.util.Optional<java.lang.String> getCharset()
```
    Gets Optional value of charset parameter.
    
    Returns:
    
    Charset parameter.
  - qualityFactor
```
public double qualityFactor()
```
    Description copied from interface: AcceptPredicate
    
    Gets quality factor parameter ("q") as a double value. If missing, then returns 1.0
    
    Specified by:
    
    qualityFactor in interface AcceptPredicate<MediaType>
    
    Returns:
    
    Quality factor parameter.
  - test
```
public boolean test(MediaType other)
```
    Check if this media type is compatible with another media type. E.g. image/* is compatible with image/jpeg, image/png, etc. Media type parameters are ignored. The function is commutative.
    
    Specified by:
    
    test in interface java.util.function.Predicate<MediaType>
    
    Parameters:
    
    other - the media type to compare with.
    
    Returns:
    
    true if the types are compatible, false otherwise.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Compares obj to this media type to see if they are the same by comparing type, subtype and parameters. Note that the case-sensitivity of parameter values is dependent on the semantics of the parameter name, see HTTP/1.1. This method assumes that values are case-sensitive.
    Note that the equals(...) implementation does not perform a class equality check (this.getClass() == obj.getClass()). Therefore any class that extends from MediaType class and needs to override one of the equals(...) and hashCode() methods must always override both methods to ensure the contract between Object.equals(java.lang.Object) and Object.hashCode() does not break.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - the object to compare to.
    
    Returns:
    
    true if the two media types are the same, false otherwise.
  - hashCode
```
public int hashCode()
```
    Generate a hash code from the type, subtype and parameters.
    Note that the equals(java.lang.Object) implementation does not perform a class equality check (this.getClass() == obj.getClass()). Therefore any class that extends from MediaType class and needs to override one of the equals(Object) and hashCode() methods must always override both methods to ensure the contract between Object.equals(java.lang.Object) and Object.hashCode() does not break.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a generated hash code.
  - toString
```
public java.lang.String toString()
```
    Convert the media type to a string suitable for use as the value of a corresponding HTTP header.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string version of the media type.
  - hasSuffix
```
public boolean hasSuffix(java.lang.String suffix)
```
    Tests if this media type has provided Structured Syntax suffix (RFC 6839).
    
    Parameters:
    
    suffix - Suffix with or without '+' prefix. If null or empty then returns true if this media type has ANY suffix.
    
    Returns:
    
    true if media type has specified suffix or has any suffix if parameter is null or empty.

Class MediaType

Field Summary

Fields inherited from interface io.helidon.common.http.AcceptPredicate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.function.Predicate

Field Detail

CHARSET_PARAMETER

WILDCARD

APPLICATION_XML

APPLICATION_ATOM_XML

APPLICATION_XHTML_XML

APPLICATION_SVG_XML

APPLICATION_JSON

APPLICATION_FORM_URLENCODED

MULTIPART_FORM_DATA

APPLICATION_OCTET_STREAM

TEXT_PLAIN

TEXT_XML

TEXT_HTML

XML_PREDICATE

JSON_PREDICATE

Constructor Detail

MediaType

MediaType

MediaType

MediaType

Method Detail

parse

getType

isWildcardType

getSubtype

isWildcardSubtype

getParameters

withCharset

getCharset

qualityFactor

test

equals

hashCode

toString

hasSuffix