libcore.content.type

Class MimeMap

java.lang.Object

libcore.content.type.MimeMap

public final class MimeMap
extends Object

Maps from MIME types to file extensions and back.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MimeMap.Builder A builder for mapping of MIME types to extensions and back.

Method Summary

Modifier and Type	Method and Description
static MimeMap.Builder	builder() Creates a MIME type map builder.
MimeMap.Builder	buildUpon() Creates a MIME type map builder with values based on this instance.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
Set<String>	extensions() Returns the set of extensions that this MimeMap maps to some MIME type.
static MimeMap	getDefault() Gets system's current default MimeMap
String	guessExtensionFromMimeType(String mimeType) Returns the registered extension for the given case insensitive MIME type.
String	guessMimeTypeFromExtension(String extension) Returns the MIME type for the given case insensitive file extension, or null if the extension isn't mapped to any.
boolean	hasExtension(String extension) Returns whether the given case insensitive extension has a registered MIME type.
int	hashCode() Returns an integer hash code for this object.
boolean	hasMimeType(String mimeType) Returns whether given case insensetive MIME type is mapped to a file extension.
Set<String>	mimeTypes() Returns the set of MIME types that this MimeMap maps to some extension.
static void	setDefaultSupplier(Supplier<MimeMap> mimeMapSupplier) Sets the Supplier of the default MimeMap instance to be used from now on.
String	toString() Returns a string containing a concise, human-readable description of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

@NonNull
public static MimeMap.Builder builder()

Creates a MIME type map builder.

Returns:

builder

See Also:

MimeMap.Builder

buildUpon

@NonNull
public MimeMap.Builder buildUpon()

Creates a MIME type map builder with values based on this instance. This builder will contain all previously added MIMEs and extensions.

Returns:

builder

See Also:

MimeMap.Builder

getDefault

@NonNull
public static MimeMap getDefault()

Gets system's current default MimeMap

Returns:

The system's current default MimeMap.

setDefaultSupplier

public static void setDefaultSupplier(@NonNull
                                      Supplier<MimeMap> mimeMapSupplier)

Sets the Supplier of the default MimeMap instance to be used from now on. mimeMapSupplier.get() will be invoked only the first time that getDefault() is called after this method call; that MimeMap instance is memoized such that subsequent calls to getDefault() without an intervening call to setDefaultSupplier(Supplier) will return that same instance without consulting mimeMapSupplier a second time.

hasExtension

public final boolean hasExtension(@Nullable
                                  String extension)

Returns whether the given case insensitive extension has a registered MIME type.

Parameters:

extension - A file extension without the leading '.'

Returns:

Whether a MIME type has been registered for the given case insensitive file extension.

guessMimeTypeFromExtension

@Nullable
public final String guessMimeTypeFromExtension(@Nullable
                                                         String extension)

Returns the MIME type for the given case insensitive file extension, or null if the extension isn't mapped to any.

Parameters:

extension - A file extension without the leading '.'

Returns:

The lower-case MIME type registered for the given case insensitive file extension, or null if there is none.

hasMimeType

public final boolean hasMimeType(@Nullable
                                 String mimeType)

Returns whether given case insensetive MIME type is mapped to a file extension.

Parameters:

mimeType - A MIME type (i.e. {@code "text/plain")

Returns:

Whether the given case insensitive MIME type is mapped to a file extension.

guessExtensionFromMimeType

@Nullable
public final String guessExtensionFromMimeType(@Nullable
                                                         String mimeType)

Returns the registered extension for the given case insensitive MIME type. Note that some MIME types map to multiple extensions. This call will return the most common extension for the given MIME type.

Parameters:

mimeType - A MIME type (i.e. text/plain)

Returns:

The lower-case file extension (without the leading "." that has been registered for the given case insensitive MIME type, or null if there is none.

mimeTypes

@NonNull
public Set<String> mimeTypes()

Returns the set of MIME types that this MimeMap maps to some extension. Note that the reverse mapping might not exist.

Returns:

unmodifiable Set of MIME types mapped to some extension

extensions

@NonNull
public Set<String> extensions()

Returns the set of extensions that this MimeMap maps to some MIME type. Note that the reverse mapping might not exist.

Returns:

unmodifiable Set of extensions that this MimeMap maps to some MIME type

hashCode

public int hashCode()

Description copied from class: Object

Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Overrides:

hashCode in class Object

Returns:

this object's hash code.

See Also:

Object.equals(java.lang.Object)

equals

public boolean equals(Object obj)

Description copied from class: Object

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and Object.hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Overrides:

equals in class Object

Parameters:

obj - the object to compare this instance with.

Returns:

true if the specified object is equal to this Object; false otherwise.

See Also:

Object.hashCode()

toString

public String toString()

Description copied from class: Object

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Overrides:

toString in class Object

Returns:

a printable representation of this object.