Package org.apache.tika.detect

Class NonDetectingEncodingDetector

  • All Implemented Interfaces:
    java.io.Serializable, EncodingDetector
    public class NonDetectingEncodingDetector
extends java.lang.Object
implements EncodingDetector
    Always returns the charset passed in via the initializer
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.nio.charset.Charset detect​(java.io.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.
      java.nio.charset.Charset getCharset()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • NonDetectingEncodingDetector

        public NonDetectingEncodingDetector()
        Sets charset to UTF-8.

      • NonDetectingEncodingDetector

        public NonDetectingEncodingDetector​(java.nio.charset.Charset charset)

    • Method Detail

      • detect

        public java.nio.charset.Charset detect​(java.io.InputStream input,
                                       Metadata metadata)
                                throws java.io.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:
        detected character encoding, or null
        Throws:
        java.io.IOException - if the document input stream could not be read

      • getCharset

        public java.nio.charset.Charset getCharset()