MimeType (Opencast :: common 8.7 API)

java.lang.Object
- org.opencastproject.util.MimeType

All Implemented Interfaces:

Serializable, Comparable<MimeType>
```
public final class MimeType
extends Object
implements Comparable<MimeType>, Serializable
```
This class implements the mime type. Note that mime types should not be instantiated directly but be retreived from the mime type registry MimeTypes.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

Function<MimeType,Boolean> eq
eq(org.opencastproject.util.MimeType) as a function.

Fields
Modifier and Type	Field and Description
`Function<MimeType,Boolean>`	`eq` `eq(org.opencastproject.util.MimeType)` as a function.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`asString()` Deprecated. use `toString()` instead
`int`	`compareTo(MimeType m)`
`boolean`	`eq(MimeType other)` Two mime types are considered equal if type and subtype are equal.
`boolean`	`eq(String type, String subtype)` Two mime types are considered equal if type and subtype are equal.
`boolean`	`equals(Object that)`
`Option<String>`	`getDescription()` Returns the mime type description.
`Option<String>`	`getFlavor()` Returns the flavor of this mime type.
`Option<String>`	`getFlavorDescription()` Returns the flavor description.
`String`	`getSubtype()` Returns the minor type of this mimetype.
`Option<String>`	`getSuffix()` Returns the main suffix for this mime type, that identifies files containing data of this flavor.
`String[]`	`getSuffixes()` Returns the registered suffixes for this mime type, that identify files containing data of this flavor.
`String`	`getType()` Returns the major type of this mimetype.
`boolean`	`hasFlavor(String flavor)` Returns `true` if the file has the given flavor associated.
`int`	`hashCode()`
`boolean`	`isEquivalentTo(String type, String subtype)` Returns `true` if this mime type is an equivalent for the specified type and subtype.
`static MimeType`	`mimeType(String type, String subtype)`
`static MimeType`	`mimeType(String type, String subtype, List<String> suffixes, List<MimeType> equivalents, Option<String> description, Option<String> flavor, Option<String> flavorDescription)`
`static MimeType`	`mimeType(String type, String subtype, String suffix)`
`boolean`	`supportsSuffix(String suffix)` Returns `true` if the mimetype supports the specified suffix.
`String`	`toString()` Returns the MimeType as a string of the form `type/subtype`

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

- Field Detail
  - eq
```
public final Function<MimeType,Boolean> eq
```
    eq(org.opencastproject.util.MimeType) as a function.
- Method Detail
  - mimeType
```
public static MimeType mimeType(String type,
                                String subtype,
                                List<String> suffixes,
                                List<MimeType> equivalents,
                                Option<String> description,
                                Option<String> flavor,
                                Option<String> flavorDescription)
```
  - mimeType
```
public static MimeType mimeType(String type,
                                String subtype,
                                String suffix)
```
  - mimeType
```
public static MimeType mimeType(String type,
                                String subtype)
```
  - getType
```
public String getType()
```
    Returns the major type of this mimetype.
    For example, if the mimetype is ISO Motion JPEG 2000 which is represented as video/mj2, this method will return video.
    
    Returns:
    
    the type
  - getSubtype
```
public String getSubtype()
```
    Returns the minor type of this mimetype.
    For example, if the mimetype is ISO Motion JPEG 2000 which is represented as video/mj2, this method will return mj2.
    
    Returns:
    
    the subtype
  - getSuffix
```
public Option<String> getSuffix()
```
    Returns the main suffix for this mime type, that identifies files containing data of this flavor.
    For example, files with the suffix mj2 will contain data of type video/mj2.
    
    Returns:
    
    the file suffix
  - getSuffixes
```
public String[] getSuffixes()
```
    Returns the registered suffixes for this mime type, that identify files containing data of this flavor. Note that the list includes the main suffix returned by getSuffix().
    For example, files containing ISO Motion JPEG 2000 may have file suffixes mj2 and mjp2.
    
    Returns:
    
    the registered file suffixes
  - supportsSuffix
```
public boolean supportsSuffix(String suffix)
```
    Returns true if the mimetype supports the specified suffix.
    
    Returns:
    
    true if the suffix is supported
  - getDescription
```
public Option<String> getDescription()
```
    Returns the mime type description.
    
    Returns:
    
    the description
  - getFlavor
```
public Option<String> getFlavor()
```
    Returns the flavor of this mime type.
    A flavor is a hint on a specialized variant of a general mime type. For example, a dublin core file will have a mime type of text/xml. Adding a flavor of mpeg-7 gives an additional hint on the file contents.
    
    Returns:
    
    the file's flavor
  - getFlavorDescription
```
public Option<String> getFlavorDescription()
```
    Returns the flavor description.
    
    Returns:
    
    the flavor description
  - hasFlavor
```
public boolean hasFlavor(String flavor)
```
    Returns true if the file has the given flavor associated.
    
    Returns:
    
    true if the file has that flavor
  - asString
```
public String asString()
```
    Deprecated. use toString() instead
    
    Returns the MimeType as a string of the form type/subtype
  - eq
```
public boolean eq(MimeType other)
```
    Two mime types are considered equal if type and subtype are equal.
  - eq
```
public boolean eq(String type,
                  String subtype)
```
    Two mime types are considered equal if type and subtype are equal.
  - isEquivalentTo
```
public boolean isEquivalentTo(String type,
                              String subtype)
```
    Returns true if this mime type is an equivalent for the specified type and subtype.
    For example, a gzipped file may have both of these mime types defined, application/x-compressed or application/x-gzip.
    
    Returns:
    
    true if this mime type is equal
  - compareTo
```
public int compareTo(MimeType m)
```
    Specified by:
    
    compareTo in interface Comparable<MimeType>
    
    See Also:
    
    Comparable.compareTo(java.lang.Object)
  - toString
```
public String toString()
```
    Returns the MimeType as a string of the form type/subtype
    
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object

Class MimeType

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

eq

Method Detail

mimeType

mimeType

mimeType

getType

getSubtype

getSuffix

getSuffixes

supportsSuffix

getDescription

getFlavor

getFlavorDescription

hasFlavor

asString

eq

eq

isEquivalentTo

compareTo

toString

hashCode

equals