Package org.apache.tika.detect

Class OverrideEncodingDetector

java.lang.Object

org.apache.tika.detect.OverrideEncodingDetector

All Implemented Interfaces:

Serializable, SelfConfiguring, EncodingDetector

public class OverrideEncodingDetector
extends Object
implements EncodingDetector

Always returns the charset passed in via the initializer

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OverrideEncodingDetector.Config	Configuration class for JSON deserialization.

Field Summary

Fields

Modifier and Type	Field	Description
static Charset	DEFAULT_CHARSET

Constructor Summary

Constructors

Constructor	Description
OverrideEncodingDetector()	Sets charset to UTF-8.
OverrideEncodingDetector(Charset charset)	Constructor with explicit Charset object.
OverrideEncodingDetector(JsonConfig jsonConfig)	Constructor for JSON configuration.
OverrideEncodingDetector(OverrideEncodingDetector.Config config)	Constructor with explicit Config object.

Method Summary

Modifier and Type	Method	Description
List<EncodingResult>	detect(TikaInputStream tis, Metadata metadata, ParseContext parseContext)	Detects the character encoding of the given text document.
Charset	getCharset()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CHARSET

public static Charset DEFAULT_CHARSET

Constructor Details

OverrideEncodingDetector

public OverrideEncodingDetector()

Sets charset to UTF-8.

OverrideEncodingDetector

public OverrideEncodingDetector(OverrideEncodingDetector.Config config)

Constructor with explicit Config object.

Parameters:

config - the configuration

OverrideEncodingDetector

public OverrideEncodingDetector(JsonConfig jsonConfig)

Constructor for JSON configuration. Requires Jackson on the classpath.

Parameters:

jsonConfig - JSON configuration

OverrideEncodingDetector

public OverrideEncodingDetector(Charset charset)

Constructor with explicit Charset object.

Parameters:

charset - the charset to always return

Method Details

detect

public List<EncodingResult> detect(TikaInputStream tis,
 Metadata metadata,
 ParseContext parseContext)
                            throws IOException

Description copied from interface: EncodingDetector

Detects the character encoding of the given text document.

Returns an empty list if the encoding cannot be determined. Returns a ranked list of candidates in descending confidence order otherwise. The first entry is always the best guess.

If the document input stream is not available, then the first argument may be null. Otherwise the detector may read bytes from the start of the stream to help in encoding detection. The given stream is guaranteed to support the mark feature and the detector is expected to mark the stream before reading any bytes from it, and to reset the stream before returning. The stream must not be closed by the detector.

The given input metadata is only read, not modified, by the detector.

Specified by:

detect in interface EncodingDetector

Parameters:

tis - text document input stream, or null

metadata - input metadata for the document

parseContext - the parse context

Returns:

ranked list of encoding results, empty if unknown; never null

Throws:

IOException - if the document input stream could not be read

getCharset

public Charset getCharset()