MediaType (http-s3 0.0.18 API)

java.lang.Object
- io.higgs.http.server.resource.MediaType

```
public class MediaType
extends Object
```
An abstraction for a media type. Instances are immutable. Based on Oracle Jersey MediaType

See Also:
Oracle Jersey docs, HTTP/1.1 section 3.7

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`APPLICATION_ATOM_XML` "application/atom+xml"
`static MediaType`	`APPLICATION_ATOM_XML_TYPE` "application/atom+xml"
`static String`	`APPLICATION_FORM_URLENCODED` "application/x-www-form-urlencoded"
`static MediaType`	`APPLICATION_FORM_URLENCODED_TYPE` "application/x-www-form-urlencoded"
`static String`	`APPLICATION_JSON` "application/json"
`static MediaType`	`APPLICATION_JSON_TYPE` "application/json"
`static String`	`APPLICATION_OCTET_STREAM` "application/octet-stream"
`static MediaType`	`APPLICATION_OCTET_STREAM_TYPE` "application/octet-stream"
`static String`	`APPLICATION_SVG_XML` "application/svg+xml"
`static MediaType`	`APPLICATION_SVG_XML_TYPE` "application/svg+xml"
`static String`	`APPLICATION_XHTML_XML` "application/xhtml+xml"
`static MediaType`	`APPLICATION_XHTML_XML_TYPE` "application/xhtml+xml"
`static String`	`APPLICATION_XML` "application/xml"
`static MediaType`	`APPLICATION_XML_TYPE` "application/xml"
`static String`	`MEDIA_TYPE_WILDCARD` The value of a type or subtype wildcard: "*"
`static String`	`MULTIPART_FORM_DATA` "multipart/form-data"
`static MediaType`	`MULTIPART_FORM_DATA_TYPE` "multipart/form-data"
`static String`	`TEXT_HTML` "text/html"
`static MediaType`	`TEXT_HTML_TYPE` "text/html"
`static String`	`TEXT_PLAIN` "text/plain"
`static MediaType`	`TEXT_PLAIN_TYPE` "text/plain"
`static String`	`TEXT_XML` "text/xml"
`static MediaType`	`TEXT_XML_TYPE` "text/xml"
`static String`	`WILDCARD` "/"
`static MediaType`	`WILDCARD_TYPE` "/"

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`static int`	`countOccurrences(String haystack, char needle)`
`boolean`	`equals(Object obj)` Compares obj to this media type to see if they are the same by comparing type, subtype and parameters.
`Map<String,String>`	`getParameters()` Getter for a read-only parameter map.
`String`	`getSubtype()` Getter for subtype.
`String`	`getType()` Getter for primary type.
`int`	`hashCode()` Generate a hashcode from the type, subtype and parameters.
`boolean`	`isCompatible(MediaType other)` Check if this media type is compatible with another media type.
`boolean`	`isWildcardSubtype()` Checks if the subtype is a wildcard
`boolean`	`isWildcardType()` Checks if the primary type is a wildcard.
`String`	`toString()` Convert the media type to a string suitable for use as the value of a corresponding HTTP header.
`static LinkedList<MediaType>`	`valueOf(String mtype)` Creates a new instance of MediaType by parsing the supplied string.

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

- Field Detail
  - MEDIA_TYPE_WILDCARD
```
public static final String MEDIA_TYPE_WILDCARD
```
    The value of a type or subtype wildcard: "*"
    
    See Also:
    Constant Field Values
  - WILDCARD
```
public static final String WILDCARD
```
    "*/*"
    
    See Also:
    Constant Field Values
  - WILDCARD_TYPE
```
public static final MediaType WILDCARD_TYPE
```
    "*/*"
  - APPLICATION_XML
```
public static final String APPLICATION_XML
```
    "application/xml"
    
    See Also:
    Constant Field Values
  - APPLICATION_XML_TYPE
```
public static final MediaType APPLICATION_XML_TYPE
```
    "application/xml"
  - APPLICATION_ATOM_XML
```
public static final String APPLICATION_ATOM_XML
```
    "application/atom+xml"
    
    See Also:
    Constant Field Values
  - APPLICATION_ATOM_XML_TYPE
```
public static final MediaType APPLICATION_ATOM_XML_TYPE
```
    "application/atom+xml"
  - APPLICATION_XHTML_XML
```
public static final String APPLICATION_XHTML_XML
```
    "application/xhtml+xml"
    
    See Also:
    Constant Field Values
  - APPLICATION_XHTML_XML_TYPE
```
public static final MediaType APPLICATION_XHTML_XML_TYPE
```
    "application/xhtml+xml"
  - APPLICATION_SVG_XML
```
public static final String APPLICATION_SVG_XML
```
    "application/svg+xml"
    
    See Also:
    Constant Field Values
  - APPLICATION_SVG_XML_TYPE
```
public static final MediaType APPLICATION_SVG_XML_TYPE
```
    "application/svg+xml"
  - APPLICATION_JSON
```
public static final String APPLICATION_JSON
```
    "application/json"
    
    See Also:
    Constant Field Values
  - APPLICATION_JSON_TYPE
```
public static final MediaType APPLICATION_JSON_TYPE
```
    "application/json"
  - APPLICATION_FORM_URLENCODED
```
public static final String APPLICATION_FORM_URLENCODED
```
    "application/x-www-form-urlencoded"
    
    See Also:
    Constant Field Values
  - APPLICATION_FORM_URLENCODED_TYPE
```
public static final MediaType APPLICATION_FORM_URLENCODED_TYPE
```
    "application/x-www-form-urlencoded"
  - MULTIPART_FORM_DATA
```
public static final String MULTIPART_FORM_DATA
```
    "multipart/form-data"
    
    See Also:
    Constant Field Values
  - MULTIPART_FORM_DATA_TYPE
```
public static final MediaType MULTIPART_FORM_DATA_TYPE
```
    "multipart/form-data"
  - APPLICATION_OCTET_STREAM
```
public static final String APPLICATION_OCTET_STREAM
```
    "application/octet-stream"
    
    See Also:
    Constant Field Values
  - APPLICATION_OCTET_STREAM_TYPE
```
public static final MediaType APPLICATION_OCTET_STREAM_TYPE
```
    "application/octet-stream"
  - TEXT_PLAIN
```
public static final String TEXT_PLAIN
```
    "text/plain"
    
    See Also:
    Constant Field Values
  - TEXT_PLAIN_TYPE
```
public static final MediaType TEXT_PLAIN_TYPE
```
    "text/plain"
  - TEXT_XML
```
public static final String TEXT_XML
```
    "text/xml"
    
    See Also:
    Constant Field Values
  - TEXT_XML_TYPE
```
public static final MediaType TEXT_XML_TYPE
```
    "text/xml"
  - TEXT_HTML
```
public static final String TEXT_HTML
```
    "text/html"
    
    See Also:
    Constant Field Values
  - TEXT_HTML_TYPE
```
public static final MediaType TEXT_HTML_TYPE
```
    "text/html"
- Constructor Detail
  - MediaType
```
public MediaType()
```
    Creates a new instance of MediaType, both type and subtype are wildcards. Consider using the constant WILDCARD_TYPE instead.
  - MediaType
```
public MediaType(String type,
         String subtype)
```
    Creates a new instance of MediaType with the supplied type and subtype.
    
    Parameters:
    type - the primary type, null is equivalent to MEDIA_TYPE_WILDCARD
    subtype - the subtype, null is equivalent to MEDIA_TYPE_WILDCARD
  - MediaType
```
public MediaType(String type,
         String subtype,
         Map<String,String> parameters)
```
    Creates a new instance of MediaType with the supplied type, subtype and parameters.
    
    Parameters:
    type - the primary type, null is equivalent to MEDIA_TYPE_WILDCARD.
    subtype - the subtype, null is equivalent to MEDIA_TYPE_WILDCARD.
    parameters - a map of media type parameters, null is the same as an empty map.
- Method Detail
  - valueOf
```
public static LinkedList<MediaType> valueOf(String mtype)
```
    Creates a new instance of MediaType by parsing the supplied string. Order is implicit by definition
    
    Parameters:
    mtype - the media type string
    
    Returns:
    the newly created MediaType
    
    Throws:
    
    IllegalArgumentException - if the supplied string cannot be parsed or is null
  - countOccurrences
```
public static int countOccurrences(String haystack,
                   char needle)
```
  - isWildcardType
```
public boolean isWildcardType()
```
    Checks if the primary type is a wildcard.
    
    Returns:
    true if the primary type is a wildcard
  - getType
```
public String getType()
```
    Getter for primary type.
    
    Returns:
    value of primary type.
  - isWildcardSubtype
```
public boolean isWildcardSubtype()
```
    Checks if the subtype is a wildcard
    
    Returns:
    true if the subtype is a wildcard
  - getSubtype
```
public String getSubtype()
```
    Getter for subtype.
    
    Returns:
    value of subtype.
  - getParameters
```
public Map<String,String> getParameters()
```
    Getter for a read-only parameter map. Keys are case-insensitive.
    
    Returns:
    an immutable map of parameters.
  - isCompatible
```
public boolean isCompatible(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.
    
    Parameters:
    other - the media type to compare with
    
    Returns:
    true if the types are compatible, false otherwise.
  - hashCode
```
public int hashCode()
```
    Generate a hashcode from the type, subtype and parameters.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    a hashcode
  - equals
```
public boolean equals(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.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - the object to compare to
    
    Returns:
    true if the two media types are the same, false otherwise.
  - toString
```
public String toString()
```
    Convert the media type to a string suitable for use as the value of a corresponding HTTP header.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a stringified media type

Class MediaType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MEDIA_TYPE_WILDCARD

WILDCARD

WILDCARD_TYPE

APPLICATION_XML

APPLICATION_XML_TYPE

APPLICATION_ATOM_XML

APPLICATION_ATOM_XML_TYPE

APPLICATION_XHTML_XML

APPLICATION_XHTML_XML_TYPE

APPLICATION_SVG_XML

APPLICATION_SVG_XML_TYPE

APPLICATION_JSON

APPLICATION_JSON_TYPE

APPLICATION_FORM_URLENCODED

APPLICATION_FORM_URLENCODED_TYPE

MULTIPART_FORM_DATA

MULTIPART_FORM_DATA_TYPE

APPLICATION_OCTET_STREAM

APPLICATION_OCTET_STREAM_TYPE

TEXT_PLAIN

TEXT_PLAIN_TYPE

TEXT_XML

TEXT_XML_TYPE

TEXT_HTML

TEXT_HTML_TYPE

Constructor Detail

MediaType

MediaType

MediaType

Method Detail

valueOf

countOccurrences

isWildcardType

getType

isWildcardSubtype

getSubtype

getParameters

isCompatible

hashCode

equals

toString