MediaType (Mule API 1.0.0-rc API)

java.lang.Object
- org.mule.runtime.api.metadata.MediaType

All Implemented Interfaces:

Serializable
```
public final class MediaType
extends Object
implements Serializable
```
Immutable representation of Media Types as defined in RFC-2046 Part Two.
Also provides constants for common media types used in Mule.

Since:

1.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static MediaType`	`ANY`
`static MediaType`	`APPLICATION_JAVA`
`static MediaType`	`APPLICATION_JSON`
`static MediaType`	`APPLICATION_XML`
`static MediaType`	`ATOM`
`static MediaType`	`BINARY`
`static MediaType`	`HTML`
`static MediaType`	`JSON`
`static MediaType`	`MULTIPART_FORM_DATA`
`static MediaType`	`MULTIPART_MIXED`
`static MediaType`	`MULTIPART_RELATED`
`static MediaType`	`MULTIPART_X_MIXED_REPLACE`
`static MediaType`	`RSS`
`static MediaType`	`TEXT`
`static MediaType`	`UNKNOWN`
`static MediaType`	`XML`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MediaType`	`create(String primaryType, String subType)` Returns a media-type for.
`static MediaType`	`create(String primaryType, String subType, Charset charset)` Returns a media-type for the given parameters.
`boolean`	`equals(Object obj)`
`Optional<Charset>`	`getCharset()`
`String`	`getParameter(String paramName)`
`String`	`getPrimaryType()`
`String`	`getSubType()`
`int`	`hashCode()`
`boolean`	`matches(MediaType other)` Evaluates the type of this object against the ones of the `other` `MediaType`.
`static MediaType`	`parse(String mediaType)` Parses a media type from its string representation.
`String`	`toRfcString()`
`String`	`toString()`
`MediaType`	`withCharset(Charset charset)` Creates a new `MediaType` instance keeping the `type` and `sub-type` but replacing the `charset` with the value passed.
`MediaType`	`withoutParameters()` Creates a new `MediaType` instance keeping the `type` and `sub-type` but removing all the parameters (like the `charset`)

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

- Field Detail
  - ANY
```
public static final MediaType ANY
```
  - JSON
```
public static final MediaType JSON
```
  - APPLICATION_JSON
```
public static final MediaType APPLICATION_JSON
```
  - APPLICATION_JAVA
```
public static final MediaType APPLICATION_JAVA
```
  - ATOM
```
public static final MediaType ATOM
```
  - RSS
```
public static final MediaType RSS
```
  - APPLICATION_XML
```
public static final MediaType APPLICATION_XML
```
  - XML
```
public static final MediaType XML
```
  - TEXT
```
public static final MediaType TEXT
```
  - HTML
```
public static final MediaType HTML
```
  - BINARY
```
public static final MediaType BINARY
```
  - UNKNOWN
```
public static final MediaType UNKNOWN
```
  - MULTIPART_MIXED
```
public static final MediaType MULTIPART_MIXED
```
  - MULTIPART_FORM_DATA
```
public static final MediaType MULTIPART_FORM_DATA
```
  - MULTIPART_RELATED
```
public static final MediaType MULTIPART_RELATED
```
  - MULTIPART_X_MIXED_REPLACE
```
public static final MediaType MULTIPART_X_MIXED_REPLACE
```
- Method Detail
  - parse
```
public static MediaType parse(String mediaType)
```
    Parses a media type from its string representation.
    
    Parameters:
    
    mediaType - String representation to be parsed
    
    Returns:
    
    MediaType instance for the parsed mediaType string.
    
    Throws:
    
    IllegalArgumentException - if the mimeType cannot be parsed.
  - create
```
public static MediaType create(String primaryType,
                               String subType)
```
    Returns a media-type for. This would be the equivalent of the media type "{primaryType}/{subType}".
    
    Parameters:
    
    primaryType - the left part of the represented type.
    
    subType - the right part of the represented type.
    
    Returns:
    
    MediaType instance for given parameters.
  - create
```
public static MediaType create(String primaryType,
                               String subType,
                               Charset charset)
```
    Returns a media-type for the given parameters. This would be the equivalent of the media type "{primaryType}/{subType}[; charset={charset}]".
    
    Parameters:
    
    primaryType - the left part of the represented type.
    
    subType - the right part of the represented type.
    
    charset - the value of the charset parameter.
    
    Returns:
    
    MediaType instance for given parameters.
  - withCharset
```
public MediaType withCharset(Charset charset)
```
    Creates a new MediaType instance keeping the type and sub-type but replacing the charset with the value passed.
    
    Parameters:
    
    charset - the new charset to use or null to clear the current charset.
    
    Returns:
    
    new immutable MediaType instance.
  - withoutParameters
```
public MediaType withoutParameters()
```
    Creates a new MediaType instance keeping the type and sub-type but removing all the parameters (like the charset)
    
    Returns:
    
    new immutable MediaType instance.
  - getPrimaryType
```
public String getPrimaryType()
```
    Returns:
    
    The left part of the represented type.
  - getSubType
```
public String getSubType()
```
    Returns:
    
    The right part of the represented type.
  - getCharset
```
public Optional<Charset> getCharset()
```
    Returns:
    
    The value of the charset parameter.
    This may be not set, in which case it is up to the caller to determine the appropriate charset to use.
  - getParameter
```
public String getParameter(String paramName)
```
    Parameters:
    
    paramName - the name of the parameter to get.
    
    Returns:
    
    The value of the paramName parameter.
  - matches
```
public boolean matches(MediaType other)
```
    Evaluates the type of this object against the ones of the other MediaType.
    This will ignore any optional parameters, such as the charset.
    
    Parameters:
    
    other - The MediaType to evaluate against.
    
    Returns:
    
    true if the types are the same.
  - toRfcString
```
public String toRfcString()
```
    Returns:
    
    a textual representation of this object, in format "{primaryType}/{subType}[; charset={charset}][; {params}]".
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a textual representation of this object.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class MediaType

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ANY

JSON

APPLICATION_JSON

APPLICATION_JAVA

ATOM

RSS

APPLICATION_XML

XML

TEXT

HTML

BINARY

UNKNOWN

MULTIPART_MIXED

MULTIPART_FORM_DATA

MULTIPART_RELATED

MULTIPART_X_MIXED_REPLACE

Method Detail

parse

create

create

withCharset

withoutParameters

getPrimaryType

getSubType

getCharset

getParameter

matches

toRfcString

toString

hashCode

equals