Deprecated API

Contents

• Deprecated Classes
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors

Deprecated Classes

Class and Description
org.apache.tika.parser.xml.MetadataHandler Use the AttributeMetadataHandler and ElementMetadataHandler classes instead
org.apache.tika.detect.OverrideDetector after 2.5.0 this functionality was moved to the CompositeDetector
org.apache.tika.example.PickBestTextEncodingParser Currently not suitable for real use, more a demo / prototype!
org.apache.tika.eval.core.tokens.TokenCounter use CompositeTextStatsCalculator with TokenEntropy, TokenLengths and TopNTokens.
org.apache.tika.metadata.XMPDM.ChannelTypePropertyConverter Experimental method, will change shortly

Deprecated Fields

Field and Description
org.apache.tika.metadata.IPTC.CATEGORY
org.apache.tika.metadata.IPTC.COPYRIGHT_OWNER_ID_WRONG_CASE use IPTC.COPYRIGHT_OWNER_ID
org.apache.tika.metadata.IPTC.DIGITAL_SOURCE_FILE_TYPE
org.apache.tika.metadata.IPTC.IMAGE_CREATOR_ID_WRONG_CASE use IPTC.IMAGE_CREATOR_ID
org.apache.tika.metadata.IPTC.IMAGE_SUPPLIER_ID_WRONG_CASE use IPTC.IMAGE_SUPPLIER_ID
org.apache.tika.metadata.IPTC.LICENSOR_ID_WRONG_CASE use IPTC.LICENSOR_ID
org.apache.tika.parser.pdf.PDFParser.PASSWORD Supply a PasswordProvider on the ParseContext instead
org.apache.tika.metadata.OfficeOpenXMLCore.SUBJECT
org.apache.tika.metadata.IPTC.SUPPLEMENTAL_CATEGORIES
org.apache.tika.metadata.IPTC.URGENCY

Deprecated Methods

Method and Description
org.apache.tika.batch.fs.FSUtil.checkThisIsAncestorOfOrSameAsThat(File, File)
org.apache.tika.batch.fs.FSUtil.checkThisIsAncestorOfThat(File, File)
org.apache.tika.eval.core.tokens.CommonTokenCountManager.countTokenOverlaps(String, Map<String, MutableInt>)
org.apache.tika.sax.ContentHandlerDecoratorFactory.decorate(ContentHandler, Metadata) use ContentHandlerDecoratorFactory.decorate(ContentHandler, Metadata, ParseContext) This will be removed in 2.5.0
org.apache.tika.detect.microsoft.POIFSContainerDetector.detect(Set<String>) Use POIFSContainerDetector.detect(Set, DirectoryEntry) and pass the root entry of the filesystem whose type is to be detected, as a second argument.
org.apache.tika.detect.ole.MiscOLEDetector.detect(Set<String>) Use MiscOLEDetector.detect(Set, DirectoryEntry) and pass the root entry of the filesystem whose type is to be detected, as a second argument.
org.apache.tika.io.TikaInputStream.get(File) use TikaInputStream.get(Path). In Tika 2.0, this will be removed or modified to throw an IOException.
org.apache.tika.io.TikaInputStream.get(File, Metadata) use TikaInputStream.get(Path, Metadata). In Tika 2.0, this will be removed or modified to throw an IOException.
org.apache.tika.io.TikaInputStream.get(InputStream, TemporaryResources) use TikaInputStream.get(InputStream, TemporaryResources, Metadata)
org.apache.tika.parser.microsoft.chm.ChmBlockInfo.getChmBlockInfoInstance(DirectoryListingEntry, int, ChmLzxcControlData)
org.apache.tika.extractor.EmbeddedDocumentUtil.getConfig() as of 1.17, use EmbeddedDocumentUtil.getTikaConfig() instead
org.apache.tika.parser.txt.CharsetDetector.getDetectableCharsets() This API is ICU internal only.
org.apache.tika.util.PropsUtil.getFile(String, File)
org.apache.tika.server.core.InputStreamFactory.getInputStream(InputStream, Metadata, HttpHeaders) use InputStreamFactory.getInputStream(InputStream, Metadata, HttpHeaders, UriInfo)
org.apache.tika.fork.ForkParser.getJavaCommand() since 1.8
org.apache.tika.parser.microsoft.rtf.RTFParser.getMaxBytesForEmbeddedObject()
org.apache.tika.mime.MimeTypes.getMimeType(File) Use Tika.detect(File) instead
org.apache.tika.mime.MimeTypes.getMimeType(String) Use Tika.detect(String) instead
org.apache.tika.sax.ContentHandlerFactory.getNewContentHandler(OutputStream, String) use ContentHandlerFactory.getNewContentHandler(OutputStream, Charset)
org.apache.tika.batch.fs.FSUtil.getOutputFile(File, String, FSUtil.HANDLE_EXISTING, String)
org.apache.tika.config.TikaConfig.getParser(MediaType) Use the TikaConfig.getParser() method instead
org.apache.tika.parser.jdbc.AbstractDBParser.getTableReader(Connection, String, ParseContext) use AbstractDBParser.getTableReader(Connection, String, EmbeddedDocumentUtil)
org.apache.tika.eval.app.db.JDBCUtil.insert(PreparedStatement, TableInfo, Map<Cols, String>)
org.apache.tika.parser.html.HtmlParser.isDiscardElement(String) Use the HtmlMapper mechanism to customize the HTML mapping. This method will be removed in Tika 1.0.
org.apache.tika.parser.pdf.PDFParser.isExtractAnnotationText() use PDFParser.getPDFParserConfig()
org.apache.tika.parser.pdf.PDFParser.isSortByPosition() use PDFParser.getPDFParserConfig()
org.apache.tika.parser.pdf.PDFParser.isSuppressDuplicateOverlappingText() use PDFParser.getPDFParserConfig()
org.apache.tika.parser.html.HtmlParser.mapSafeAttribute(String, String) Use the HtmlMapper mechanism to customize the HTML mapping. This method will be removed in Tika 1.0.
org.apache.tika.parser.html.HtmlParser.mapSafeElement(String) Use the HtmlMapper mechanism to customize the HTML mapping. This method will be removed in Tika 1.0.
org.apache.tika.parser.multiple.AbstractMultipleParser.parse(InputStream, ContentHandlerFactory, Metadata, ParseContext) The ContentHandlerFactory override is still experimental and the method signature is subject to change before Tika 2.0
org.apache.tika.parser.AbstractParser.parse(InputStream, ContentHandler, Metadata) use the Parser.parse(InputStream, ContentHandler, Metadata, ParseContext) method instead
org.apache.tika.parser.iptc.IptcAnpaParser.parse(InputStream, ContentHandler, Metadata) This method will be removed in Apache Tika 1.0.
org.apache.tika.parser.digestutils.CommonsDigester.parse(String) use the CommonsDigester(int, String) instead
org.apache.tika.parser.microsoft.OutlookExtractor.parse(XHTMLContentHandler, Metadata) use #parse(XHTMLContentHandler), will be removed after 2.4.0
org.apache.tika.parser.txt.CharsetDetector.setDetectableCharset(String, boolean) This API is ICU internal only.
org.apache.tika.fork.ForkParser.setJavaCommand(String) since 1.8
org.apache.tika.parser.microsoft.rtf.RTFParser.setMaxBytesForEmbeddedObject(int) use RTFParser.setMemoryLimitInKb(int) instead
org.apache.tika.pipes.CompositePipesReporter.setPipesReporters(List<PipesReporter>) use CompositePipesReporter.addPipesReporter(PipesReporter)
org.apache.tika.parser.RegexCaptureParser.setRegexMap(Map<String, String>)
org.apache.tika.parser.ParserDecorator.withFallbacks(Collection<? extends Parser>, Set<MediaType>) This has been replaced by FallbackParser

Deprecated Constructors

Constructor and Description
org.apache.tika.parser.mp3.AudioFrame(InputStream, ContentHandler) Use the constructor which is passed all values directly.
org.apache.tika.parser.mp3.AudioFrame(int, int, int, int, InputStream) Use the constructor which is passed all values directly.
org.apache.tika.batch.fs.BasicTikaFSConsumer(ArrayBlockingQueue<FileResource>, ParserFactory, ContentHandlerFactory, OutputStreamFactory, TikaConfig) use BasicTikaFSConsumer(ArrayBlockingQueue, Parser, ContentHandlerFactory, OutputStreamFactory)
org.apache.tika.parser.digestutils.CommonsDigester(int, CommonsDigester.DigestAlgorithm...) use CommonsDigester(int, String)
org.apache.tika.batch.fs.FSFileResource(File, File) to be removed in Tika 2.0
org.apache.tika.batch.fs.FSListCrawler(ArrayBlockingQueue<FileResource>, int, File, File, String)
org.apache.tika.batch.fs.FSOutputStreamFactory(File, FSUtil.HANDLE_EXISTING, FSOutputStreamFactory.COMPRESSION, String)
org.apache.tika.parser.microsoft.OutlookExtractor(DirectoryNode, ParseContext) use OutlookExtractor(DirectoryNode, Metadata, ParseContext) Will be removed after 2.4.0
org.apache.tika.parser.microsoft.OutlookExtractor(POIFSFileSystem, ParseContext) use OutlookExtractor(DirectoryNode, Metadata, ParseContext) Will be removed after 2.4.0
org.apache.tika.sax.ToTextContentHandler(OutputStream) use ToTextContentHandler(Writer)
org.apache.tika.sax.WriteOutContentHandler(OutputStream) -- please use WriteOutContentHandler(Writer)
org.apache.tika.parser.microsoft.ooxml.XWPFWordExtractorDecorator(ParseContext, XWPFWordExtractor) use XWPFWordExtractorDecorator(Metadata, ParseContext, XWPFWordExtractor)