Package dev.enola.common.io.mediatype

Class ResourceCharsetDetectorSPI

java.lang.Object

dev.enola.common.io.mediatype.ResourceCharsetDetectorSPI

All Implemented Interfaces:

ResourceCharsetDetector

Direct Known Subclasses:

YamlMediaType

public abstract class ResourceCharsetDetectorSPI
extends Object
implements ResourceCharsetDetector

Constructor Summary

Constructors

Constructor	Description
ResourceCharsetDetectorSPI()

Method Summary

Modifier and Type	Method	Description
abstract Optional<Charset>	detectCharset(URI uri, ByteSource source)	Detect the Charset by "sniffing" the source e.g.
protected final byte[]	peek(int n, URI uri, ByteSource source)	Peeks at the first N bytes of a resource.

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceCharsetDetectorSPI

public ResourceCharsetDetectorSPI()

Method Details

detectCharset

public abstract 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

peek

protected final byte[] peek(int n,
 URI uri,
 ByteSource source)

Peeks at the first N bytes of a resource.

Returns:

byte array of length up to N bytes, or shorter if the resource had less bytes, or there was an error reading from it