Package org.apache.tika.detect

Interface Detector

All Superinterfaces:
SelfConfiguring, Serializable
All Known Implementing Classes:
BPListDetector, CompositeDetector, DefaultDetector, DefaultProbDetector, DefaultZipContainerDetector, DeprecatedStreamingZipContainerDetector, EmptyDetector, EncryptedPrescriptionDetector, FileCommandDetector, GZipSpecializationDetector, MagicDetector, MagikaDetector, MatroskaDetector, MimeTypes, MiscOLEDetector, NameDetector, NNExampleModelDetector, OggDetector, OverrideDetector, POIFSContainerDetector, ProbabilisticMimeDetectionSelector, SiegfriedDetector, StreamingZipContainerDetector, TextDetector, TrainedModelDetector, TypeDetector, ZeroSizeFileDetector
public interface Detector extends Serializable, SelfConfiguring
Content type detector. Implementations of this interface use various heuristics to detect the content type of a document based on given input metadata or the first few bytes of the document stream.
Since:
Apache Tika 0.3

  • Method Details

    • detect

      MediaType detect(TikaInputStream tis, Metadata metadata, ParseContext parseContext) throws IOException
      Detects the content type of the given input document. Returns application/octet-stream if the type 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 type detection. 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.

      Parameters:
      tis - document input stream, or null
      metadata - input metadata for the document
      parseContext - the parse context
      Returns:
      detected media type, or application/octet-stream
      Throws:
      IOException - if the document input stream could not be read