Deprecated API

Contents

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

Deprecated Classes

Class and Description
org.apache.tika.language.LanguageIdentifier use a concrete class of LanguageDetector
org.apache.tika.language.LanguageProfile
org.apache.tika.language.LanguageProfilerBuilder
org.apache.tika.parser.xml.MetadataHandler Use the AttributeMetadataHandler and ElementMetadataHandler classes instead
org.apache.tika.parser.opendocument.OpenOfficeParser Use the OpenDocumentParser class instead. This class will be removed in Apache Tika 1.0.
org.apache.tika.parser.pdf.PDFPreflightParser This will be removed in 2.x. The PDFBox community voted to retire the preflight parser in PDFBox 4.x.
org.apache.tika.language.ProfilingHandler use LanguageHandler
org.apache.tika.language.ProfilingWriter use LanguageWriter
org.apache.tika.eval.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.MSOffice.APPLICATION_NAME
org.apache.tika.metadata.MSOffice.APPLICATION_VERSION
org.apache.tika.metadata.MSOffice.AUTHOR
org.apache.tika.metadata.IPTC.CATEGORY
org.apache.tika.metadata.MSOffice.CATEGORY
org.apache.tika.metadata.MSOffice.CHARACTER_COUNT
org.apache.tika.metadata.MSOffice.CHARACTER_COUNT_WITH_SPACES
org.apache.tika.metadata.MSOffice.COMMENTS
org.apache.tika.metadata.MSOffice.COMPANY
org.apache.tika.metadata.MSOffice.CONTENT_STATUS
org.apache.tika.metadata.Metadata.CONTRIBUTOR use TikaCoreProperties#CONTRIBUTOR
org.apache.tika.metadata.IPTC.COPYRIGHT_OWNER_ID_WRONG_CASE use IPTC.COPYRIGHT_OWNER_ID
org.apache.tika.metadata.Metadata.COVERAGE use TikaCoreProperties#COVERAGE
org.apache.tika.metadata.MSOffice.CREATION_DATE
org.apache.tika.metadata.Metadata.CREATOR use TikaCoreProperties#CREATOR
org.apache.tika.metadata.Metadata.DATE use TikaCoreProperties#CREATED
org.apache.tika.metadata.Metadata.DESCRIPTION use TikaCoreProperties#DESCRIPTION
org.apache.tika.metadata.IPTC.DIGITAL_SOURCE_FILE_TYPE
org.apache.tika.parser.RecursiveParserWrapper.EMBEDDED_EXCEPTION use AbstractRecursiveParserWrapperHandler.EMBEDDED_EXCEPTION
org.apache.tika.parser.RecursiveParserWrapper.EMBEDDED_RESOURCE_LIMIT_REACHED use AbstractRecursiveParserWrapperHandler.EMBEDDED_RESOURCE_LIMIT_REACHED
org.apache.tika.parser.RecursiveParserWrapper.EMBEDDED_RESOURCE_PATH use AbstractRecursiveParserWrapperHandler.EMBEDDED_RESOURCE_PATH
org.apache.tika.metadata.Metadata.FORMAT use TikaCoreProperties#FORMAT
org.apache.tika.metadata.Metadata.IDENTIFIER use TikaCoreProperties#IDENTIFIER
org.apache.tika.metadata.MSOffice.IMAGE_COUNT
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.MSOffice.KEYWORDS
org.apache.tika.metadata.Metadata.LANGUAGE use TikaCoreProperties#LANGUAGE
org.apache.tika.metadata.MSOffice.LAST_AUTHOR
org.apache.tika.metadata.MSOffice.LAST_PRINTED
org.apache.tika.metadata.MSOffice.LAST_SAVED
org.apache.tika.metadata.IPTC.LICENSOR_ID_WRONG_CASE use IPTC.LICENSOR_ID
org.apache.tika.metadata.MSOffice.LINE_COUNT
org.apache.tika.metadata.MSOffice.MANAGER
org.apache.tika.metadata.Metadata.MODIFIED use TikaCoreProperties#MODIFIED
org.apache.tika.metadata.MSOffice.NOTES
org.apache.tika.metadata.MSOffice.OBJECT_COUNT
org.apache.tika.metadata.MSOffice.PAGE_COUNT
org.apache.tika.metadata.MSOffice.PARAGRAPH_COUNT
org.apache.tika.parser.RecursiveParserWrapper.PARSE_TIME_MILLIS use AbstractRecursiveParserWrapperHandler.PARSE_TIME_MILLIS
org.apache.tika.parser.pdf.PDFParser.PASSWORD Supply a PasswordProvider on the ParseContext instead
org.apache.tika.metadata.MSOffice.PRESENTATION_FORMAT
org.apache.tika.metadata.Metadata.PUBLISHER use TikaCoreProperties#PUBLISHER
org.apache.tika.metadata.Metadata.RELATION use TikaCoreProperties#RELATION
org.apache.tika.metadata.MSOffice.REVISION_NUMBER
org.apache.tika.metadata.Metadata.RIGHTS use TikaCoreProperties#RIGHTS
org.apache.tika.metadata.MSOffice.SECURITY
org.apache.tika.metadata.MSOffice.SLIDE_COUNT
org.apache.tika.metadata.Metadata.SOURCE use TikaCoreProperties#SOURCE
org.apache.tika.metadata.Metadata.SUBJECT use TikaCoreProperties#KEYWORDS
org.apache.tika.metadata.IPTC.SUPPLEMENTAL_CATEGORIES
org.apache.tika.metadata.MSOffice.TABLE_COUNT
org.apache.tika.metadata.MSOffice.TEMPLATE
org.apache.tika.parser.RecursiveParserWrapper.TIKA_CONTENT use AbstractRecursiveParserWrapperHandler.TIKA_CONTENT
org.apache.tika.metadata.Metadata.TITLE use TikaCoreProperties#TITLE
org.apache.tika.metadata.MSOffice.TOTAL_TIME
org.apache.tika.metadata.TikaCoreProperties.TRANSITION_KEYWORDS_TO_DC_SUBJECT use TikaCoreProperties#KEYWORDS
org.apache.tika.metadata.TikaCoreProperties.TRANSITION_SUBJECT_TO_DC_DESCRIPTION use TikaCoreProperties#DESCRIPTION
org.apache.tika.metadata.TikaCoreProperties.TRANSITION_SUBJECT_TO_DC_TITLE use TikaCoreProperties#TITLE
org.apache.tika.metadata.TikaCoreProperties.TRANSITION_SUBJECT_TO_OO_SUBJECT use OfficeOpenXMLCore#SUBJECT
org.apache.tika.metadata.Metadata.TYPE use TikaCoreProperties#TYPE
org.apache.tika.metadata.IPTC.URGENCY
org.apache.tika.metadata.MSOffice.VERSION
org.apache.tika.metadata.MSOffice.WORD_COUNT
org.apache.tika.parser.RecursiveParserWrapper.WRITE_LIMIT_REACHED use AbstractRecursiveParserWrapperHandler.EMBEDDED_EXCEPTION

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.tokens.CommonTokenCountManager.countTokenOverlaps(String, Map<String, MutableInt>)
org.apache.tika.parser.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.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.parser.chm.lzx.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.parser.pdf.PDFParser.getExtractAnnotationText() use PDFParser.getPDFParserConfig()
org.apache.tika.util.PropsUtil.getFile(String, File)
org.apache.tika.server.URLEnabledInputStreamFactory.getInputSteam(InputStream, HttpHeaders) use URLEnabledInputStreamFactory.getInputSteam(InputStream, Metadata, HttpHeaders)
org.apache.tika.fork.ForkParser.getJavaCommand() since 1.8
org.apache.tika.parser.rtf.RTFParser.getMaxBytesForEmbeddedObject()
org.apache.tika.parser.RecursiveParserWrapper.getMetadata() use a RecursiveParserWrapperHandler instead
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.parser.pdf.PDFParserConfig.getOcrImageScale() as of Tika 1.23, this is no longer used in rendering page images; use PDFParserConfig.setOcrDPI(int)
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.pdf.PDFParser.getSortByPosition() use PDFParser.getPDFParserConfig()
org.apache.tika.parser.pdf.PDFParser.getSuppressDuplicateOverlappingText() use PDFParser.getPDFParserConfig()
org.apache.tika.eval.db.JDBCUtil.insert(PreparedStatement, TableInfo, Map<Cols, String>)
org.apache.tika.parser.pdf.PDFParserConfig.isCatchIntermediateIOExceptions() use PDFParserConfig.getCatchIntermediateIOExceptions()
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.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.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.utils.CommonsDigester.parse(String) use the CommonsDigester(int, String) instead
org.apache.tika.parser.ocr.TesseractOCRParser.parseInline(InputStream, XHTMLContentHandler, TesseractOCRConfig) use TesseractOCRParser.parseInline(InputStream, XHTMLContentHandler, ParseContext, TesseractOCRConfig)
org.apache.tika.parser.RecursiveParserWrapper.reset() use a RecursiveParserWrapperHandler instead
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.rtf.RTFParser.setMaxBytesForEmbeddedObject(int) use RTFParser.setMemoryLimitInKb(int) instead
org.apache.tika.parser.RecursiveParserWrapper.setMaxEmbeddedResources(int) set this on a RecursiveParserWrapperHandler
org.apache.tika.parser.pdf.PDFParserConfig.setMaxMainMemoryBytes(int) use PDFParserConfig.setMaxMainMemoryBytes(long)
org.apache.tika.parser.pdf.PDFParserConfig.setOcrImageScale(float) (as of Tika 1.23, this is no longer used in rendering page images)
org.apache.tika.io.IOUtils.toByteArray(String) Use String.getBytes()
org.apache.tika.io.IOUtils.toString(byte[]) Use String(byte[])
org.apache.tika.io.IOUtils.toString(byte[], String) Use String(byte[],String)
org.apache.tika.parser.ParserDecorator.withFallbacks(Collection<? extends Parser>, Set<MediaType>) Do not use until the TODOs are resolved, see TIKA-1509
org.apache.tika.io.IOUtils.write(StringBuffer, OutputStream) replaced by write(CharSequence, OutputStream)
org.apache.tika.io.IOUtils.write(StringBuffer, OutputStream, String) replaced by write(CharSequence, OutputStream, String)
org.apache.tika.io.IOUtils.write(StringBuffer, Writer) replaced by write(CharSequence, Writer)

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.utils.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.RecursiveParserWrapper(Parser, ContentHandlerFactory) use RecursiveParserWrapper(Parser)
org.apache.tika.parser.RecursiveParserWrapper(Parser, ContentHandlerFactory, boolean) use RecursiveParserWrapper(Parser, boolean)
org.apache.tika.parser.microsoft.ooxml.XWPFWordExtractorDecorator(ParseContext, XWPFWordExtractor) use XWPFWordExtractorDecorator(Metadata, ParseContext, XWPFWordExtractor)