MediaType (Pitaya 0.4 API)

java.lang.Object
- org.kocakosm.pitaya.net.MediaType

All Implemented Interfaces:

Serializable
```
public final class MediaType
extends Object
implements Serializable
```
Represents an Internet Media Type. This class also supports the concept of media ranges defined by HTTP/1.1. The * character is treated as a wildcard and is used to represent any acceptable type or subtype value. All values for type, subtype, parameter attributes or parameter values must be valid according to RFCs 2045 and 2046. All portions of the media type that are case-insensitive (type, subtype, parameter attributes) are normalized to lowercase. Parameters' values are not modified except for the charset parameter which is normalised to uppercase. Instances of this class are immutable.

Since:

0.3

Author:

Osman KOCAK

See Also:
RFC 2045, RFC 2046, RFC 2616 (§ 14.1), Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static MediaType`	`ANY_APPLICATION_TYPE` `application/*`
`static MediaType`	`ANY_AUDIO_TYPE` `audio/*`
`static MediaType`	`ANY_IMAGE_TYPE` `image/*`
`static MediaType`	`ANY_TEXT_TYPE` `text/*`
`static MediaType`	`ANY_TYPE` `/`
`static MediaType`	`ANY_VIDEO_TYPE` `video/*`
`static MediaType`	`CSS` `text/css`
`static MediaType`	`GIF` `image/gif`
`static MediaType`	`HTML` `text/html`
`static MediaType`	`JPEG` `image/jpeg`
`static MediaType`	`JSON` `application/json`
`static MediaType`	`OCTET_STREAM` `application/octet-stream`
`static MediaType`	`PLAIN_TEXT` `text/plain`
`static MediaType`	`PNG` `image/png`
`static MediaType`	`XML` `application/xml`

Method Summary

Methods
Modifier and Type	Method and Description
`Charset`	`charset()` Returns the value of the charset parameter if it is specified, or `null` otherwise.
`static MediaType`	`create(String type, String subtype)` Creates a new `MediaType` with the given type and subtype.
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`boolean`	`hasWildcard()` Returns whether the type or the subtype of this media type is the wildcard.
`boolean`	`is(MediaType range)` Returns whether this media type is within the specified media range.
`Map<String,String>`	`parameters()` Returns the parameters of this media type.
`static MediaType`	`parse(String input)` Parses a `MediaType` from its `String` representation.
`String`	`subtype()` Returns the media subtype.
`String`	`toString()`
`String`	`type()` Returns the top-level media type.
`MediaType`	`withCharset(Charset charset)` Returns a new `MediaType` instance similar to this one but with the `charset` parameter set to the `name` of the given charset.
`MediaType`	`withoutParameter(String attribute)` Returns a new `MediaType` instance similar to this one but without the specified parameter.
`MediaType`	`withoutParameters()` Returns a new `MediaType` instance with the same type and subtype as this instance but without any parameters.
`MediaType`	`withParameter(String attribute, String value)` Returns a new `MediaType` instance similar to this one but with the specified parameter set to the given value.
`MediaType`	`withParameters(Map<String,String> parameters)` Returns a new `MediaType` instance having the same type and subtype as this one but whose parameters is the "union" of this instances' parameters with the given ones (the given parameters have precedence over this instance's parameters).

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

- Field Detail
  - ANY_TYPE
```
public static final MediaType ANY_TYPE
```
    */*
  - ANY_TEXT_TYPE
```
public static final MediaType ANY_TEXT_TYPE
```
    text/*
  - ANY_IMAGE_TYPE
```
public static final MediaType ANY_IMAGE_TYPE
```
    image/*
  - ANY_AUDIO_TYPE
```
public static final MediaType ANY_AUDIO_TYPE
```
    audio/*
  - ANY_VIDEO_TYPE
```
public static final MediaType ANY_VIDEO_TYPE
```
    video/*
  - ANY_APPLICATION_TYPE
```
public static final MediaType ANY_APPLICATION_TYPE
```
    application/*
  - JPEG
```
public static final MediaType JPEG
```
    image/jpeg
  - PNG
```
public static final MediaType PNG
```
    image/png
  - GIF
```
public static final MediaType GIF
```
    image/gif
  - CSS
```
public static final MediaType CSS
```
    text/css
  - HTML
```
public static final MediaType HTML
```
    text/html
  - PLAIN_TEXT
```
public static final MediaType PLAIN_TEXT
```
    text/plain
  - JSON
```
public static final MediaType JSON
```
    application/json
  - XML
```
public static final MediaType XML
```
    application/xml
  - OCTET_STREAM
```
public static final MediaType OCTET_STREAM
```
    application/octet-stream
- Method Detail
  - parse
```
public static MediaType parse(String input)
```
    Parses a MediaType from its String representation.
    
    Parameters:
    input - the input String to be parsed.
    
    Returns:
    the parsed MediaType instance.
    
    Throws:
    
    NullPointerException - if input is null.
    
    IllegalArgumentException - if input can't be parsed or if a wildcard is used for the type, but not for the subtype.
  - create
```
public static MediaType create(String type,
               String subtype)
```
    Creates a new MediaType with the given type and subtype.
    
    Parameters:
    type - the type.
    subtype - the subtype.
    
    Returns:
    the created MediaType instance.
    
    Throws:
    
    NullPointerException - if one of the arguments is null.
    
    IllegalArgumentException - if type or subtype is invalid or if a wildcard is used for the type, but not for the subtype.
  - type
```
public String type()
```
    Returns the top-level media type.
    
    Returns:
    the top-level media type.
  - subtype
```
public String subtype()
```
    Returns the media subtype.
    
    Returns:
    the media subtype.
  - parameters
```
public Map<String,String> parameters()
```
    Returns the parameters of this media type. The returned Map is immutable.
    
    Returns:
    the parameters of this media type.
  - hasWildcard
```
public boolean hasWildcard()
```
    Returns whether the type or the subtype of this media type is the wildcard.
    
    Returns:
    whether this media type has a wildcard.
  - charset
```
public Charset charset()
```
    Returns the value of the charset parameter if it is specified, or null otherwise.
    
    Returns:
    the charset parameter's value if present, or null otherwise.
    
    Throws:
    
    IllegalCharsetNameException - if the charset is illegal.
    
    UnsupportedCharsetException - if the charset is not supported.
  - withCharset
```
public MediaType withCharset(Charset charset)
```
    Returns a new MediaType instance similar to this one but with the charset parameter set to the name of the given charset.
    
    Parameters:
    charset - the charset.
    
    Returns:
    the created MediaType.
    
    Throws:
    
    NullPointerException - if charset is null.
  - withParameter
```
public MediaType withParameter(String attribute,
                      String value)
```
    Returns a new MediaType instance similar to this one but with the specified parameter set to the given value.
    
    Parameters:
    attribute - the attribute of the parameter to add.
    value - the value of the parameter to add.
    
    Returns:
    the created MediaType.
    
    Throws:
    
    NullPointerException - if one of the arguments is null.
    
    IllegalArgumentException - if attribute is invalid.
  - withParameters
```
public MediaType withParameters(Map<String,String> parameters)
```
    Returns a new MediaType instance having the same type and subtype as this one but whose parameters is the "union" of this instances' parameters with the given ones (the given parameters have precedence over this instance's parameters).
    
    Parameters:
    parameters - the parameters.
    
    Returns:
    the created MediaType.
    
    Throws:
    
    NullPointerException - if parameters is null or if it contains the null key or a null value.
    
    IllegalArgumentException - if parameters contains an invalid attribute.
  - withoutParameter
```
public MediaType withoutParameter(String attribute)
```
    Returns a new MediaType instance similar to this one but without the specified parameter.
    
    Parameters:
    attribute - the attribute of the parameter to remove.
    
    Returns:
    the created MediaType.
    
    Throws:
    
    NullPointerException - if attribute is null.
  - withoutParameters
```
public MediaType withoutParameters()
```
    Returns a new MediaType instance with the same type and subtype as this instance but without any parameters.
    
    Returns:
    the created MediaType.
  - is
```
public boolean is(MediaType range)
```
    Returns whether this media type is within the specified media range. Namely, it returns true if the type of range is the wildcard or is equal to the type of this instance, and, if the subtype of range is the wildcard or is equal to the subtype of this instance, and, if all the parameters present in range are also present in this instance.
    
    Parameters:
    range - the range to check this media type against.
    
    Returns:
    whether this media type is within the specified range.
    
    Throws:
    
    NullPointerException - if range is null.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MediaType

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ANY_TYPE

ANY_TEXT_TYPE

ANY_IMAGE_TYPE

ANY_AUDIO_TYPE

ANY_VIDEO_TYPE

ANY_APPLICATION_TYPE

JPEG

PNG

GIF

CSS

HTML

PLAIN_TEXT

JSON

XML

OCTET_STREAM

Method Detail

parse

create

type

subtype

parameters

hasWildcard

charset

withCharset

withParameter

withParameters

withoutParameter

withoutParameters

is

equals

hashCode

toString