Package org.apache.tika.parser.txt

Class UniversalEncodingDetector

java.lang.Object

org.apache.tika.parser.txt.UniversalEncodingDetector

All Implemented Interfaces:

Serializable, SelfConfiguring, EncodingDetector

public class UniversalEncodingDetector
extends Object
implements EncodingDetector

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
UniversalEncodingDetector()	Default constructor for SPI loading.
UniversalEncodingDetector(JsonConfig jsonConfig)	Constructor for JSON configuration.
UniversalEncodingDetector(UniversalEncodingDetector.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.
UniversalEncodingDetector.Config	getDefaultConfig()

Methods inherited from class java.lang.Object

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

Constructor Details

UniversalEncodingDetector

public UniversalEncodingDetector()

Default constructor for SPI loading.

UniversalEncodingDetector

public UniversalEncodingDetector(UniversalEncodingDetector.Config config)

Constructor with explicit Config object.

Parameters:

config - the configuration

UniversalEncodingDetector

public UniversalEncodingDetector(JsonConfig jsonConfig)

Constructor for JSON configuration. Requires Jackson on the classpath.

Parameters:

jsonConfig - JSON configuration

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

getDefaultConfig

public UniversalEncodingDetector.Config getDefaultConfig()