Package org.apache.tika.detect

Class CompositeEncodingDetector

java.lang.Object

org.apache.tika.detect.CompositeEncodingDetector

All Implemented Interfaces:

Serializable, EncodingDetector

Direct Known Subclasses:

DefaultEncodingDetector

public class CompositeEncodingDetector
extends Object
implements EncodingDetector, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CompositeEncodingDetector(List<EncodingDetector> detectors)
CompositeEncodingDetector(List<EncodingDetector> detectors, Collection<Class<? extends EncodingDetector>> excludeEncodingDetectors)

Method Summary

Modifier and Type	Method	Description
Charset	detect(InputStream input, Metadata metadata)	Detects the character encoding of the given text document, or null if the encoding of the document can not be detected.
List<EncodingDetector>	getDetectors()

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeEncodingDetector

public CompositeEncodingDetector(List<EncodingDetector> detectors,
                                 Collection<Class<? extends EncodingDetector>> excludeEncodingDetectors)

CompositeEncodingDetector

public CompositeEncodingDetector(List<EncodingDetector> detectors)

Method Detail

detect

public Charset detect(InputStream input,
                      Metadata metadata)
               throws IOException

Description copied from interface: EncodingDetector

Detects the character encoding of the given text document, or null if the encoding of the document can not be detected.

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:

input - text document input stream, or null

metadata - input metadata for the document

Returns:

the detected Charset or null if no charset could be detected

Throws:

IOException

getDetectors

public List<EncodingDetector> getDetectors()