MediaType (52°North Jan Mayen 7.3.1 API)

java.lang.Object
- org.n52.janmayen.http.MediaType

All Implemented Interfaces:: Comparable<MediaType>, Similar<MediaType>

public class MediaType
extends Object
implements Comparable<MediaType>, Similar<MediaType>

TODO JavaDoc

Since:: 1.0.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`APPLICATION_TYPE`
`static String`	`AUDIO_TYPE`
`static String`	`IMAGE_TYPE`
`static String`	`MESSAGE_TYPE`
`static String`	`MODEL_TYPE`
`static String`	`MULTIPART_TYPE`
`static String`	`TEXT_TYPE`
`static String`	`VIDEO_TYPE`
`static String`	`WILDCARD_TYPE`

Constructor Summary

Constructors
Constructor and Description
`MediaType()` Constructs a `/` media type.
`MediaType(String type)` Constructs a `type/*` media type.
`MediaType(String type, String subtype)` Constructs a `type/subtype` media type.
`MediaType(String type, String subtype, Map<String,? extends Collection<String>> parameters)` Constructs a media type using the supplied parameters.
`MediaType(String type, String subtype, String parameter, String parameterValue)` Constructs a `type/subtype;parameter="name"` media type.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MediaType`	`any()`
`static MediaType`	`anyApplication()`
`static MediaType`	`anyAudio()`
`static MediaType`	`anyImage()`
`static MediaType`	`anyMessage()`
`static MediaType`	`anyModel()`
`static MediaType`	`anyMultipart()`
`static MediaType`	`anyText()`
`static MediaType`	`anyVideo()`
`static MediaType`	`application(String subtype)`
`static MediaType`	`application(String subtype, String parameterName, String parameterValue)`
`static MediaType`	`audio(String subtype)`
`int`	`compareTo(MediaType o)`
`boolean`	`equals(Object obj)`
`Collection<String>`	`getParameter(String parameter)`
`Map<String,Collection<String>>`	`getParameters()`
`float`	`getQuality()`
`int`	`getSimilarity(MediaType other)` x = 0 ⇔ equal x < 0 ⇔ not similar x > 0 ⇔ similar y > 0 & x > y ⇔ x more similar than y
`String`	`getSubtype()`
`String`	`getType()`
`int`	`hashCode()`
`boolean`	`hasParameter(String parameter)`
`boolean`	`hasParameters()`
`static MediaType`	`image(String subtype)`
`boolean`	`isCompatible(MediaType other)`
`boolean`	`isWildcard()`
`boolean`	`isWildcardSubtype()`
`boolean`	`isWildcardType()`
`static MediaType`	`message(String subtype)`
`static MediaType`	`model(String subtype)`
`static MediaType`	`multipart(String subtype)`
`static String`	`normalizeString(String string)` Normalize mime type string by processing it through the MediaType parser.
`static MediaType`	`parse(String string)`
`static MediaType`	`text(String subtype)`
`String`	`toString()`
`static MediaType`	`video(String subtype)`
`MediaType`	`withoutParameter(String parameter)`
`MediaType`	`withoutParameters()`
`MediaType`	`withoutQuality()`
`MediaType`	`withParameter(String parameter, String value)`
`MediaType`	`withParameters(Map<String,? extends Collection<String>> parameters)`
`MediaType`	`withSubType(String subtype)`
`MediaType`	`withType(String type)`

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

Field Detail
- IMAGE_TYPE
```
public static final String IMAGE_TYPE
```
  See Also:
  
  Constant Field Values
- AUDIO_TYPE
```
public static final String AUDIO_TYPE
```
  See Also:
  
  Constant Field Values
- VIDEO_TYPE
```
public static final String VIDEO_TYPE
```
  See Also:
  
  Constant Field Values
- MESSAGE_TYPE
```
public static final String MESSAGE_TYPE
```
  See Also:
  
  Constant Field Values
- MODEL_TYPE
```
public static final String MODEL_TYPE
```
  See Also:
  
  Constant Field Values
- MULTIPART_TYPE
```
public static final String MULTIPART_TYPE
```
  See Also:
  
  Constant Field Values
- APPLICATION_TYPE
```
public static final String APPLICATION_TYPE
```
  See Also:
  
  Constant Field Values
- TEXT_TYPE
```
public static final String TEXT_TYPE
```
  See Also:
  
  Constant Field Values
- WILDCARD_TYPE
```
public static final String WILDCARD_TYPE
```
  See Also:
  
  Constant Field Values

Constructor Detail
- MediaType
```
public MediaType()
```
  Constructs a */* media type.
- MediaType
```
public MediaType(String type)
```
  Constructs a type/* media type.
  
  Parameters:
  
  type - the type (may be null for a wild card)
- MediaType
```
public MediaType(String type,
                 String subtype)
```
  Constructs a type/subtype media type.
  
  Parameters:
  
  type - the type (may be null for a wild card)
  
  subtype - the subtype (may be null for a wild card)
- MediaType
```
public MediaType(String type,
                 String subtype,
                 String parameter,
                 String parameterValue)
```
  Constructs a type/subtype;parameter="name" media type.
  
  Parameters:
  
  type - the type (may be null for a wild card)
  
  subtype - the subtype (may be null for a wild card)
  
  parameter - the parameter
  
  parameterValue - the parameter value
- MediaType
```
public MediaType(String type,
                 String subtype,
                 Map<String,? extends Collection<String>> parameters)
```
  Constructs a media type using the supplied parameters.
  
  Parameters:
  
  type - the type (may be null for a wild card)
  
  subtype - the subtype (may be null for a wild card)
  
  parameters - the parameter map

Method Detail

getType
```
public String getType()
```

getSubtype
```
public String getSubtype()
```

getParameters

public Map<String,Collection<String>> getParameters()

isWildcard
```
public boolean isWildcard()
```

isWildcardType
```
public boolean isWildcardType()
```

isWildcardSubtype
```
public boolean isWildcardSubtype()
```

isCompatible

public boolean isCompatible(MediaType other)

getParameter

public Collection<String> getParameter(String parameter)

hasParameter

public boolean hasParameter(String parameter)

getQuality
```
public float getQuality()
```

withType

public MediaType withType(String type)

withSubType

public MediaType withSubType(String subtype)

hasParameters
```
public boolean hasParameters()
```

withParameter

public MediaType withParameter(String parameter,
                               String value)

withParameters

public MediaType withParameters(Map<String,? extends Collection<String>> parameters)

withoutParameter

public MediaType withoutParameter(String parameter)

withoutQuality
```
public MediaType withoutQuality()
```

withoutParameters
```
public MediaType withoutParameters()
```

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

compareTo
```
public int compareTo(MediaType o)
```
Specified by:

compareTo in interface Comparable<MediaType>

toString
```
public String toString()
```
Overrides:

toString in class Object

getSimilarity

public int getSimilarity(MediaType other)

Description copied from interface: Similar

 x = 0         ⇔ equal
 x < 0         ⇔ not similar
 x > 0         ⇔ similar
 y > 0 & x > y ⇔ x more similar than y

Specified by:: getSimilarity in interface Similar<MediaType>
Parameters:: other - the other object
Returns:: the similarity value

parse

public static MediaType parse(String string)

normalizeString
```
public static String normalizeString(String string)
```
Normalize mime type string by processing it through the MediaType parser. Handles differing spaces between type and subtype, etc.

Parameters:

string - Mime type string to normalize

Returns:

Normalized mime type string

application

public static MediaType application(String subtype)

application

public static MediaType application(String subtype,
                                    String parameterName,
                                    String parameterValue)

text

public static MediaType text(String subtype)

image

public static MediaType image(String subtype)

audio

public static MediaType audio(String subtype)

video

public static MediaType video(String subtype)

message

public static MediaType message(String subtype)

model

public static MediaType model(String subtype)

multipart

public static MediaType multipart(String subtype)

any
```
public static MediaType any()
```

anyApplication

public static MediaType anyApplication()

anyText
```
public static MediaType anyText()
```

anyImage
```
public static MediaType anyImage()
```

anyAudio
```
public static MediaType anyAudio()
```

anyVideo
```
public static MediaType anyVideo()
```

anyMessage
```
public static MediaType anyMessage()
```

anyModel
```
public static MediaType anyModel()
```

anyMultipart

public static MediaType anyMultipart()

Class MediaType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IMAGE_TYPE

AUDIO_TYPE

VIDEO_TYPE

MESSAGE_TYPE

MODEL_TYPE

MULTIPART_TYPE

APPLICATION_TYPE

TEXT_TYPE

WILDCARD_TYPE

Constructor Detail

MediaType

MediaType

MediaType

MediaType

MediaType

Method Detail

getType

getSubtype

getParameters

isWildcard

isWildcardType

isWildcardSubtype

isCompatible

getParameter

hasParameter

getQuality

withType

withSubType

hasParameters

withParameter

withParameters

withoutParameter

withoutQuality

withoutParameters

hashCode

equals

compareTo

toString

getSimilarity

parse

normalizeString

application

application

text

image

audio

video

message

model

multipart

any

anyApplication

anyText

anyImage

anyAudio

anyVideo

anyMessage

anyModel

anyMultipart