YamlMediaType

java.lang.Object

dev.enola.common.io.mediatype.ResourceCharsetDetectorSPI

dev.enola.common.io.mediatype.YamlMediaType

All Implemented Interfaces:: MediaTypeProvider, ResourceCharsetDetector, ResourceMediaTypeDetector

public class YamlMediaType extends ResourceCharsetDetectorSPI implements MediaTypeProvider

Field Summary

Fields

Modifier and Type

Field

Description

static final MediaType

YAML_UTF_8
Constructor Summary

Constructors

Constructor

Description

YamlMediaType()
Method Summary

Modifier and Type

Method

Description

Optional<Charset>

detectCharset(URI uri, ByteSource source)

Detect the Charset by "sniffing" the source e.g.

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".

Methods inherited from class dev.enola.common.io.mediatype.ResourceCharsetDetectorSPI
peek

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.MediaTypeProvider
detect

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

Field Details
- YAML_UTF_8
  
  public static final MediaType YAML_UTF_8
Constructor Details
- YamlMediaType
  
  public YamlMediaType()
Method Details
- 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
- detectCharset
  
  public Optional<Charset> detectCharset(URI uri, ByteSource source)
  
  Description copied from interface: ResourceCharsetDetector
  
  Detect the Charset by "sniffing" the source e.g. for "BOM detection". The URI argument is only uses for error messages. (It's never "accessed".)
  
  Specified by:
  
  detectCharset in interface ResourceCharsetDetector
  
  Specified by:
  
  detectCharset in class ResourceCharsetDetectorSPI