Interface Detector

All Superinterfaces:
All Known Subinterfaces:
All Known Implementing Classes:
CompositeDetector, ContainerAwareDetector, MagicDetector, MimeTypes, NameDetector, POIFSContainerDetector, TextDetector, TypeDetector, ZipContainerDetector

public interface Detector

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.

Apache Tika 0.3

Method Summary
 MediaType detect( input, Metadata metadata)
          Detects the content type of the given input document.

Method Detail


MediaType detect( input,
                 Metadata metadata)
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 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.

input - document input stream, or null
metadata - input metadata for the document
detected media type, or application/octet-stream
Throws: - if the document input stream could not be read

Copyright © 2007-2010 The Apache Software Foundation. All Rights Reserved.