BOMDetector (Apache Tika 3.0.0 API)

java.lang.Object
- org.apache.tika.parser.txt.BOMDetector

All Implemented Interfaces:

Serializable, EncodingDetector
```
public class BOMDetector
extends Object
implements EncodingDetector
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

BOMDetector()

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BOMDetector
```
public BOMDetector()
```
- 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:
    
    detected character encoding, or null
    
    Throws:
    
    IOException - if the document input stream could not be read