Package dev.enola.common.io.mediatype

Class MediaTypeProviders

java.lang.Object

dev.enola.common.io.mediatype.MediaTypeProviders

All Implemented Interfaces:

MediaTypeProvider, ResourceMediaTypeDetector

public class MediaTypeProviders
extends Object
implements MediaTypeProvider

Aggregates other MediaTypeProviders, from an explicit list provided to constructor. (This intentionally does NOT use ServiceLoader; reasons include requiring a specific priority order.) Typically used via SINGLETON.

Field Summary

Fields

Modifier and Type	Field	Description
static final Singleton<MediaTypeProviders>	SINGLETON

Constructor Summary

Constructors

Constructor	Description
MediaTypeProviders(MediaTypeProvider... providers)

Method Summary

Modifier and Type	Method	Description
MediaType	detect(String uri, ByteSource byteSource, MediaType original)	ResourceMediaTypeDetector.detect(String, ByteSource, MediaType) default implementation using MediaTypeProvider.extensionsToTypes().
Multimap<String,MediaType>	extensionsToTypes()	Maps the URI path "extension" (WITH the dot; or not, filenames such as "README" are also permitted!) to its "canonical" Media Types.
Map<MediaType,Set<MediaType>>	knownTypesWithAlternatives()	Maps "canonical" (primary) Media Types to a set of its "also known as alternatives".
MediaType	normalize(MediaType mediaType)	Attempts to "normalize" using MediaTypeProvider.knownTypesWithAlternatives().
static Singleton<MediaTypeProviders>	set(MediaTypeProvider... providers)

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.enola.common.io.mediatype.ResourceMediaTypeDetector

detect

Field Details

SINGLETON

public static final Singleton<MediaTypeProviders> SINGLETON

Constructor Details

MediaTypeProviders

public MediaTypeProviders(MediaTypeProvider... providers)

Method Details

set

public static Singleton<MediaTypeProviders> set(MediaTypeProvider... providers)

knownTypesWithAlternatives

public Map<MediaType,Set<MediaType>> knownTypesWithAlternatives()

Description copied from interface: MediaTypeProvider

Maps "canonical" (primary) Media Types to a set of its "also known as alternatives".

Specified by:

knownTypesWithAlternatives in interface MediaTypeProvider

extensionsToTypes

public Multimap<String,MediaType> extensionsToTypes()

Description copied from interface: MediaTypeProvider

Maps the URI path "extension" (WITH the dot; or not, filenames such as "README" are also permitted!) to its "canonical" Media Types. This should only be used for "informational" listing kind of output. To actually determine a MediaType, please use MediaTypeProvider.detect(String, ByteSource, MediaType) instead.

Specified by:

extensionsToTypes in interface MediaTypeProvider

detect

public MediaType detect(String uri,
 ByteSource byteSource,
 MediaType original)

Description copied from interface: MediaTypeProvider

ResourceMediaTypeDetector.detect(String, ByteSource, MediaType) default implementation using MediaTypeProvider.extensionsToTypes(). This matches the "longest" filename extension (if required).

Specified by:

detect in interface MediaTypeProvider

Specified by:

detect in interface ResourceMediaTypeDetector

normalize

public MediaType normalize(MediaType mediaType)

Attempts to "normalize" using MediaTypeProvider.knownTypesWithAlternatives().

Parameters:

mediaType - the one to try to replace

Returns:

a "canonical" one, if found; else the argument