MediaType (qetcher-client 2.0.2 API)

java.lang.Object
- de.mklinger.qetch.client.common.MediaType

```
public class MediaType
extends Object
```
Author:

Marc Klinger - mklinger[at]mklinger[dot]de

Constructor Summary

Constructors
Constructor and Description
`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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Compares `obj` to this media type to see if they are the same by comparing type, subtype and parameters.
`String`	`getFullType()` Convert the media type to a string without parameters.
`String`	`getParameter(String name)`
`boolean`	`getParameterBoolean(String name, boolean defaultValue)`
`Integer`	`getParameterInteger(String name)`
`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 hash code 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.
`static boolean`	`quoted(String str)`
`String`	`toString()` Convert the media type to a string suitable for use as the value of a corresponding HTTP header.
`static MediaType`	`valueOf(String type)` Creates a new instance of `MediaType` by parsing the supplied string.
`MediaType`	`withoutParameters()` Get an instance with same type and sub-type but without parameters.
`MediaType`	`withoutParameters(String... names)` Get an instance with same type and sub-type and parameters, but with given parameters removed.
`MediaType`	`withParameter(String name, String value)` Get an instance with same type, sub-type and parameters with an additional parameter as given.
`MediaType`	`withParameters(Map<String,String> additionalParameters)` Get an instance with same type, sub-type and parameters with additional parameters as given.

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

- Constructor Detail
  - 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.
  - 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
- Method Detail
  - valueOf
```
public static MediaType valueOf(String type)
```
    Creates a new instance of MediaType by parsing the supplied string.
    
    Parameters:
    
    type - the media type string.
    
    Returns:
    
    the newly created MediaType.
    
    Throws:
    
    IllegalArgumentException - if the supplied string cannot be parsed or is null.
  - getType
```
public 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 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 Map<String,String> getParameters()
```
    Getter for a read-only parameter map. Keys are case-insensitive.
    
    Returns:
    
    an immutable map of parameters.
  - withoutParameters
```
public MediaType withoutParameters()
```
    Get an instance with same type and sub-type but without parameters.
  - withoutParameters
```
public MediaType withoutParameters(String... names)
```
    Get an instance with same type and sub-type and parameters, but with given parameters removed.
  - withParameter
```
public MediaType withParameter(String name,
                               String value)
```
    Get an instance with same type, sub-type and parameters with an additional parameter as given. If there was already a parameter with the same name, its value will be replaced by the new value.
  - withParameters
```
public MediaType withParameters(Map<String,String> additionalParameters)
```
    Get an instance with same type, sub-type and parameters with additional parameters as given. If there where already parameters with the same names, its values will be replaced by the new values.
  - 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.
  - 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.
    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 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 Object
    
    Returns:
    
    a generated hash code.
  - 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 string version of the media type.
  - getFullType
```
public String getFullType()
```
    Convert the media type to a string without parameters.
    
    Returns:
    
    a string version of the media type without parameters.
  - quoted
```
public static boolean quoted(String str)
```
  - getParameter
```
public String getParameter(String name)
```
  - getParameterInteger
```
public Integer getParameterInteger(String name)
```
  - getParameterBoolean
```
public boolean getParameterBoolean(String name,
                                   boolean defaultValue)
```

Class MediaType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MediaType

MediaType

Method Detail

valueOf

getType

isWildcardType

getSubtype

isWildcardSubtype

getParameters

withoutParameters

withoutParameters

withParameter

withParameters

isCompatible

equals

hashCode

toString

getFullType

quoted

getParameter

getParameterInteger

getParameterBoolean