com.phloc.commons.mime

Class MimeTypeDeterminator

java.lang.Object

com.phloc.commons.mime.MimeTypeDeterminator

@ThreadSafe
public final class MimeTypeDeterminator
extends Object

Contains a basic set of MimeType determination method.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static IMimeType	DEFAULT_MIME_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
static Map<String,String>	getAllKnownMimeTypeFilenameMappings()
static Collection<String>	getAllKnownMimeTypes()
static List<MimeTypeContent>	getAllMimeTypeContents()
static IMimeType	getMimeTypeFromBytes(byte[] b) Try to determine the MIME type from the given byte array.
static IMimeType	getMimeTypeFromBytes(byte[] b, IMimeType aDefault) Try to determine the MIME type from the given byte array.
static String	getMimeTypeFromExtension(String sExtension) Get the MIME type from the passed filename extension.
static String	getMimeTypeFromFilename(String sFilename) Get the MIME type from the extension of the passed filename.
static IMimeType	getMimeTypeFromString(String s, Charset aCharset) Try to find the MIME type that matches the passed content string.
static IMimeType	getMimeTypeFromString(String s, Charset aCharset, IMimeType aDefault) Try to find the MIME type that matches the passed content string.
static IMimeType	getMimeTypeFromString(String s, String sCharsetName) Deprecated.
static MimeType	getMimeTypeObjectFromExtension(String sExtension) Get the MIME type object from the passed filename extension.
static MimeType	getMimeTypeObjectFromFilename(String sFilename) Get the MIME type object from the extension of the passed filename.
static EChange	registerMimeTypeContent(MimeTypeContent aMimeTypeContent) Register a new MIME content type.
static void	resetCache() Reset the MimeTypeContent cache to the initial state.
static EChange	unregisterMimeTypeContent(MimeTypeContent aMimeTypeContent) Unregister an existing MIME content type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_MIME_TYPE

public static final IMimeType DEFAULT_MIME_TYPE

Method Detail

registerMimeTypeContent

@Nonnull
public static EChange registerMimeTypeContent(@Nonnull
                                      MimeTypeContent aMimeTypeContent)

Register a new MIME content type.

Parameters:

aMimeTypeContent - The content type to register. May not be null.

Returns:

EChange.CHANGED if the object was successfully registered.

unregisterMimeTypeContent

@Nonnull
public static EChange unregisterMimeTypeContent(@Nullable
                                        MimeTypeContent aMimeTypeContent)

Unregister an existing MIME content type.

Parameters:

aMimeTypeContent - The content type to unregister. May not be null.

Returns:

EChange.CHANGED if the object was successfully unregistered.

getMimeTypeFromString

@Nonnull
@Deprecated
public static IMimeType getMimeTypeFromString(@Nullable
                                                 String s,
                                                 @Nonnull@Nonempty
                                                 String sCharsetName)

Deprecated.

Try to find the MIME type that matches the passed content string.

Parameters:

s - The content string to check. May be null.

sCharsetName - The charset used to convert the string to a byte array. May neither be null nor empty.

Returns:

null if no matching MIME type was found.

getMimeTypeFromString

@Nonnull
public static IMimeType getMimeTypeFromString(@Nullable
                                      String s,
                                      @Nonnull
                                      Charset aCharset)

Try to find the MIME type that matches the passed content string.

Parameters:

s - The content string to check. May be null.

aCharset - The charset used to convert the string to a byte array. May not be null.

Returns:

DEFAULT_MIME_TYPE if no matching MIME type was found. Never null.

getMimeTypeFromString

@Nullable
public static IMimeType getMimeTypeFromString(@Nullable
                                       String s,
                                       @Nonnull
                                       Charset aCharset,
                                       @Nullable
                                       IMimeType aDefault)

Try to find the MIME type that matches the passed content string.

Parameters:

s - The content string to check. May be null.

aCharset - The charset used to convert the string to a byte array. May not be null.

aDefault - The default MIME type to be returned, if no MIME type could be found. May be null.

Returns:

aDefault if no matching MIME type was found. May be null.

getMimeTypeFromBytes

@Nonnull
public static IMimeType getMimeTypeFromBytes(@Nullable
                                     byte[] b)

Try to determine the MIME type from the given byte array.

Parameters:

b - The byte array to parse. May be null or empty.

Returns:

DEFAULT_MIME_TYPE if no specific MIME type was found. Never null.

getMimeTypeFromBytes

@Nullable
public static IMimeType getMimeTypeFromBytes(@Nullable
                                      byte[] b,
                                      @Nullable
                                      IMimeType aDefault)

Try to determine the MIME type from the given byte array.

Parameters:

b - The byte array to parse. May be null or empty.

aDefault - The default MIME type to be returned, if no matching MIME type was found. May be null.

Returns:

The supplied default value, if no matching MIME type was found. May be null.

getAllMimeTypeContents

@Nonnull
@ReturnsMutableCopy
public static List<MimeTypeContent> getAllMimeTypeContents()

Returns:

A copy of all registered MimeTypeContent objects. Never null but maybe empty.

getMimeTypeFromFilename

@Nullable
public static String getMimeTypeFromFilename(@Nullable
                                      String sFilename)

Get the MIME type from the extension of the passed filename.

Parameters:

sFilename - The filename to check. May be null.

Returns:

null if no MIME type was found.

getMimeTypeObjectFromFilename

@Nullable
public static MimeType getMimeTypeObjectFromFilename(@Nonnull
                                              String sFilename)

Get the MIME type object from the extension of the passed filename.

Parameters:

sFilename - The filename to check. May be null.

Returns:

null if no MIME type was found.

getMimeTypeFromExtension

@Nullable
public static String getMimeTypeFromExtension(@Nullable
                                       String sExtension)

Get the MIME type from the passed filename extension.

Parameters:

sExtension - The extension to check. Must be without the leading dot, so "doc" is valid but ".doc" is not. May be null.

Returns:

null if no MIME type was found.

getMimeTypeObjectFromExtension

@Nullable
public static MimeType getMimeTypeObjectFromExtension(@Nullable
                                               String sExtension)

Get the MIME type object from the passed filename extension.

Parameters:

sExtension - The extension to check. Must be without the leading dot, so "doc" is valid but ".doc" is not. May be null.

Returns:

null if no MIME type was found.

getAllKnownMimeTypes

@Nonnull
@ReturnsMutableCopy
public static Collection<String> getAllKnownMimeTypes()

Returns:

A non-null list of all known MIME types as string.

getAllKnownMimeTypeFilenameMappings

@Nonnull
@ReturnsMutableCopy
public static Map<String,String> getAllKnownMimeTypeFilenameMappings()

Returns:

A non-null map from filename extension to MIME type. Never null.

resetCache

public static void resetCache()

Reset the MimeTypeContent cache to the initial state.

See Also:

registerMimeTypeContent(MimeTypeContent), unregisterMimeTypeContent(MimeTypeContent)