MimeTypeUtil (Sitevision API)

All Superinterfaces:

VelocityAccess.MimeTypeUtilConstants
```
@Requireable(value="MimeTypeUtil")
public interface MimeTypeUtil
extends VelocityAccess.MimeTypeUtilConstants
```
A utility that determines an appropriate MIME type for a file extension or vice versa.
An instance of the Sitevision class implementing this interface can be obtained via Utils.getMimeTypeUtil(). See Utils for how to obtain an instance of the Utils interface.

Since:

Sitevision 3.0

Author:

Magnus Lövgren

Field Summary

Fields
Modifier and Type Field and Description

static String GENERIC_MIME_TYPE
The generic application/octet-stream MIME type.

Fields
Modifier and Type	Field and Description
`static String`	`GENERIC_MIME_TYPE` The generic `application/octet-stream` MIME type.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getExtension(String aMimeType)` Returns the file extension for a specified MIME type.
`String`	`getExtension(String aMimeType, String aFallbackExtension)` Returns the file extension (or a fallback extension) for a specified MIME type.
`String`	`getMimeType(String aFileExtensionExpression)` Returns the MIME type appropriate for a specified file extension.
`String`	`getMimeType(String aFileExtensionExpression, String aFallbackMimeType)` Returns the MIME type (or a fallback MIME type) appropriate for a specified file extension.
`boolean`	`isCompressedType(String aFileExtensionExpression)` Checks if a specified file extension is a compressed/archive type (according to its mapped MIME type).
`boolean`	`isFontType(String aFileExtensionExpression)` Checks if a specified file extension is a font type (according to its mapped MIME type).
`boolean`	`isImageType(String aFileExtensionExpression)` Checks if a specified file extension is an image type (according to its mapped MIME type).
`boolean`	`isMSExcelType(String aFileExtensionExpression)` Checks if a specified file extension is a MS Excel type (according to its mapped MIME type).
`boolean`	`isMSOfficeType(String aFileExtensionExpression)` Checks if a specified file extension is a MS Office type (according to its mapped MIME type).
`boolean`	`isMSPowerpointType(String aFileExtensionExpression)` Checks if a specified file extension is a MS Powerpoint type (according to its mapped MIME type).
`boolean`	`isMSWordType(String aFileExtensionExpression)` Checks if a specified file extension is a MS Word type (according to its mapped MIME type).
`boolean`	`isTextType(String aFileExtensionExpression)` Checks if a specified file extension is a text type (according to its mapped MIME type).
`boolean`	`isVideoType(String aFileExtensionExpression)` Checks if a specified file extension is a video type (according to its mapped MIME type).
`boolean`	`isXmlType(String aFileExtensionExpression)` Checks if a specified file extension is a text type (according to its mapped MIME type).

Methods inherited from interface senselogic.sitevision.api.render.velocity.VelocityAccess.MimeTypeUtilConstants
getGENERIC_MIME_TYPE

- Field Detail
  - GENERIC_MIME_TYPE
```
static final String GENERIC_MIME_TYPE
```
    The generic application/octet-stream MIME type.
    Would typically be appropriate to use as value for the fallback MIME type when using the getMimeType(String, String) whenever you require an acceptable, non-null MIME type to be returned.
```
    String mime = aMimeTypeUtil.getMimeType(anExtension, MimeTypeUtil.GENERIC_MIME_TYPE);
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getMimeType
```
String getMimeType(String aFileExtensionExpression)
```
    Returns the MIME type appropriate for a specified file extension.
    
    Parameters:
    
    aFileExtensionExpression - a file extension (e.g pdf) or an expression that ends with a period and a file extension (e.g myfile.pdf or http://www.xyz.com/files/myfile.pdf). Case insensitive.
    
    Returns:
    
    a MIME type that matches the extension in aFileExtensionExpression, or null if extension is unknown
    
    See Also:
    
    getMimeType(String, String)
  - getMimeType
```
String getMimeType(String aFileExtensionExpression,
                   String aFallbackMimeType)
```
    Returns the MIME type (or a fallback MIME type) appropriate for a specified file extension.
    
    Parameters:
    
    aFileExtensionExpression - a file extension (e.g pdf) or an expression that ends with a period and a file extension (e.g myfile.pdf or http://www.xyz.com/files/myfile.pdf). Case insensitive.
    
    aFallbackMimeType - the fallback MIME type to return if no MIME type can be found for aFileExtensionExpression
    
    Returns:
    
    a MIME type that matches the extension in aFileExtensionExpression, or aFallbackMimeType if extension is unknown
  - getExtension
```
String getExtension(String aMimeType)
```
    Returns the file extension for a specified MIME type.
    
    Parameters:
    
    aMimeType - a MIME type. Case insensitive.
    
    Returns:
    
    the lowercased default file extension for MIME type aMimeType, or null if aMimeType is unknown or has no single well-known extension (e.g. application/octet-stream or text/plain)
    
    See Also:
    
    getExtension(String, String)
  - getExtension
```
String getExtension(String aMimeType,
                    String aFallbackExtension)
```
    Returns the file extension (or a fallback extension) for a specified MIME type.
    
    Parameters:
    
    aMimeType - a MIME type. Case insensitive.
    
    aFallbackExtension - the fallback extension to return if no extension can be found for aMimeType
    
    Returns:
    
    the lowercased default file extension for MIME type aMimeType, or aFallbackExtension if aMimeType is unknown or has no single well-known extension (e.g. application/octet-stream or text/plain)
  - isImageType
```
boolean isImageType(String aFileExtensionExpression)
```
    Checks if a specified file extension is an image type (according to its mapped MIME type).
    An image type has a MIME that starts with image/.
    
    Parameters:
    
    aFileExtensionExpression - a file extension (e.g png) or an expression that ends with a period and a file extension (e.g myresource.png or http://www.xyz.com/files/myresource.png). Case insensitive.
    
    Returns:
    
    true if aFileExtensionExpression is mapped to a image/* MIME type, false otherwise
    
    Since:
    
    Sitevision 4.0
  - isTextType
```
boolean isTextType(String aFileExtensionExpression)
```
    Checks if a specified file extension is a text type (according to its mapped MIME type).
    A text type has a MIME that starts with "text/".
    
    Parameters:
    
    aFileExtensionExpression - a file extension (e.g txt) or an expression that ends with a period and a file extension (e.g myresource.txt or http://www.xyz.com/files/myresource.txt). Case insensitive.
    
    Returns:
    
    true if aFileExtensionExpression is mapped to a text/* MIME type, false otherwise
    
    Since:
    
    Sitevision 4.1
  - isXmlType
```
boolean isXmlType(String aFileExtensionExpression)
```
    Checks if a specified file extension is a text type (according to its mapped MIME type).
    A XML type typically has a MIME that starts with "application/" and ends with "xml". This method will not include xml-based files covered by other categories (e.g. "office" types or the "svg" image type).
    
    Parameters:
    
    aFileExtensionExpression - a file extension (e.g xml) or an expression that ends with a period and a file extension (e.g myresource.xml or http://www.xyz.com/files/myresource.xml). Case insensitive.
    
    Returns:
    
    true if aFileExtensionExpression is mapped to a application/*xml MIME type, false otherwise
    
    Since:
    
    Sitevision 4.1
  - isVideoType
```
boolean isVideoType(String aFileExtensionExpression)
```
    Checks if a specified file extension is a video type (according to its mapped MIME type).
    A video type has a MIME that starts with "video/".
    
    Parameters:
    
    aFileExtensionExpression - a file extension (e.g mov) or an expression that ends with a period and a file extension (e.g myresource.mov or http://www.xyz.com/files/myresource.mov). Case insensitive.
    
    Returns:
    
    true if aFileExtensionExpression is mapped to a video/* MIME type, false otherwise
    
    Since:
    
    Sitevision 4.1
  - isCompressedType
```
boolean isCompressedType(String aFileExtensionExpression)
```
    Checks if a specified file extension is a compressed/archive type (according to its mapped MIME type).
    Example of compressed MIME types:
    - application/zip
    - application/x-gzip
    - application/x-bzip
    - application/x-rar-compressed
    - application/x-lzh-compressed
    - application/x-7z-compressed
    - application/x-tar
    - application/vnd.ms-cab-compressed
    - application/java-archive
    Parameters:
    
    aFileExtensionExpression - a file extension (e.g zip) or an expression that ends with a period and a file extension (e.g myresource.zip or http://www.xyz.com/files/myresource.zip). Case insensitive.
    
    Returns:
    
    true if aFileExtensionExpression is mapped to a MIME type that is registered as compressed, false otherwise
    
    Since:
    
    Sitevision 4.1
  - isMSWordType
```
boolean isMSWordType(String aFileExtensionExpression)
```
    Checks if a specified file extension is a MS Word type (according to its mapped MIME type).
    Example of typical MS Word MIME types:
    - application/vnd.ms-word
    - application/vnd.openxmlformats-officedocument.wordprocessingml.document
    - application/vnd.openxmlformats-officedocument.wordprocessingml.template
    Parameters:
    
    aFileExtensionExpression - a file extension (e.g doc) or an expression that ends with a period and a file extension (e.g myresource.doc or http://www.xyz.com/files/myresource.doc). Case insensitive.
    
    Returns:
    
    true if aFileExtensionExpression is mapped to a MS Word MIME type, false otherwise
    
    Since:
    
    Sitevision 4.1
  - isMSExcelType
```
boolean isMSExcelType(String aFileExtensionExpression)
```
    Checks if a specified file extension is a MS Excel type (according to its mapped MIME type).
    Example of typical MS Excel MIME types:
    - application/vnd.ms-excel
    - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
    - application/vnd.openxmlformats-officedocument.spreadsheetml.template
    Parameters:
    
    aFileExtensionExpression - a file extension (e.g xls) or an expression that ends with a period and a file extension (e.g myresource.xls or http://www.xyz.com/files/myresource.xls). Case insensitive.
    
    Returns:
    
    true if aFileExtensionExpression is mapped to a MS Excel MIME type, false otherwise
    
    Since:
    
    Sitevision 4.1
  - isMSPowerpointType
```
boolean isMSPowerpointType(String aFileExtensionExpression)
```
    Checks if a specified file extension is a MS Powerpoint type (according to its mapped MIME type).
    Example of typical MS Powerpoint MIME types:
    - application/vnd.ms-powerpoint
    - application/vnd.openxmlformats-officedocument.presentationml.presentation
    - application/vnd.openxmlformats-officedocument.presentationml.template
    Parameters:
    
    aFileExtensionExpression - a file extension (e.g ppt) or an expression that ends with a period and a file extension (e.g myresource.ppt or http://www.xyz.com/files/myresource.ppt). Case insensitive.
    
    Returns:
    
    true if aFileExtensionExpression is mapped to a MS Powerpoint MIME type, false otherwise
    
    Since:
    
    Sitevision 4.1
  - isMSOfficeType
```
boolean isMSOfficeType(String aFileExtensionExpression)
```
    Checks if a specified file extension is a MS Office type (according to its mapped MIME type).
    This is a convenience method that checks if aFileExtensionExpression is mapped to a MS Word/Excel/Powerpoint MIME type. (i.e. a combination of isMSWordType(String), isMSExcelType(String) and isMSPowerpointType(String))
    
    Parameters:
    
    aFileExtensionExpression - a file extension (e.g doc) or an expression that ends with a period and a file extension (e.g myresource.xls or http://www.xyz.com/files/myresource.ppt). Case insensitive.
    
    Returns:
    
    true if aFileExtensionExpression is mapped to a MS Word/Excel/Powerpoint MIME type, false otherwise
    
    Since:
    
    Sitevision 4.1
  - isFontType
```
boolean isFontType(String aFileExtensionExpression)
```
    Checks if a specified file extension is a font type (according to its mapped MIME type).
    Example of typical font MIME types:
    - font/woff2
    - font/woff
    - font/ttf
    - font/otf
    - font/sfnt
    - font/collection
    - application/x-font-ttf
    - application/vnd.ms-fontobject
    - application/x-dfont
    Parameters:
    
    aFileExtensionExpression - a file extension (e.g woff2) or an expression that ends with a period and a file extension (e.g myresource.woff2 or http://www.xyz.com/files/myresource.woff2). Case insensitive.
    
    Returns:
    
    true if aFileExtensionExpression is mapped to a MIME type that is registered as font, false otherwise
    
    Since:
    
    Sitevision 2022.10.1

Sitevision - Portal and Content Management Made Easy
Sitevision is an advanced Java enterprise portal product and a portlet container (JSR 286) that implements Java Content Repository (JSR 283).

Interface MimeTypeUtil

Field Summary

Method Summary

Methods inherited from interface senselogic.sitevision.api.render.velocity.VelocityAccess.MimeTypeUtilConstants

Field Detail

GENERIC_MIME_TYPE

Method Detail

getMimeType

getMimeType

getExtension

getExtension

isImageType

isTextType

isXmlType

isVideoType

isCompressedType

isMSWordType

isMSExcelType

isMSPowerpointType

isMSOfficeType

isFontType