Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Enums
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors
• Deprecated Enum Constants

Deprecated Interfaces

Interface and Description
org.apache.lucene.search.FieldCache.ByteParser
org.apache.lucene.search.FieldCache.ShortParser

Deprecated Classes

Class and Description
org.apache.lucene.analysis.Analyzer.GlobalReuseStrategy This implementation class will be hidden in Lucene 5.0. Use Analyzer.GLOBAL_REUSE_STRATEGY instead!
org.apache.lucene.analysis.Analyzer.PerFieldReuseStrategy This implementation class will be hidden in Lucene 5.0. Use Analyzer.PER_FIELD_REUSE_STRATEGY instead!
org.apache.lucene.document.ByteDocValuesField use NumericDocValuesField instead.
org.apache.lucene.document.DerefBytesDocValuesField Use BinaryDocValuesField instead.
org.apache.lucene.search.FieldComparator.ByteComparator
org.apache.lucene.search.FieldComparator.ShortComparator
org.apache.lucene.util.IndexableBinaryStringTools Implement TermToBytesRefAttribute and store bytes directly instead. This class will be removed in Lucene 5.0
org.apache.lucene.document.IntDocValuesField use NumericDocValuesField instead.
org.apache.lucene.document.LongDocValuesField use NumericDocValuesField instead.
org.apache.lucene.codecs.lucene3x.Lucene3xCodec Only for reading existing 3.x indexes
org.apache.lucene.codecs.lucene3x.Lucene3xSegmentInfoFormat (4.0) This is only used to read indexes created before 4.0.
org.apache.lucene.codecs.lucene3x.Lucene3xSegmentInfoReader Only for reading existing 3.x indexes
org.apache.lucene.codecs.lucene40.Lucene40Codec Only for reading old 4.0 segments
org.apache.lucene.codecs.lucene40.Lucene40DocValuesFormat Only for reading old 4.0 and 4.1 segments
org.apache.lucene.codecs.lucene40.Lucene40FieldInfosFormat Only for reading old 4.0 and 4.1 segments
org.apache.lucene.codecs.lucene40.Lucene40NormsFormat Only for reading old 4.0 and 4.1 segments
org.apache.lucene.codecs.lucene40.Lucene40PostingsBaseFormat Only for reading old 4.0 segments
org.apache.lucene.codecs.lucene40.Lucene40PostingsFormat Only for reading old 4.0 segments
org.apache.lucene.codecs.lucene40.Lucene40PostingsReader Only for reading old 4.0 segments
org.apache.lucene.codecs.lucene40.Lucene40SegmentInfoFormat Only for reading old 4.0-4.5 segments, and supporting IndexWriter.addIndexes
org.apache.lucene.codecs.lucene40.Lucene40SegmentInfoReader Only for reading old 4.0-4.5 segments
org.apache.lucene.codecs.lucene40.Lucene40SegmentInfoWriter
org.apache.lucene.codecs.lucene40.Lucene40SkipListReader Only for reading old 4.0 segments
org.apache.lucene.codecs.lucene41.Lucene41Codec Only for reading old 4.0 segments
org.apache.lucene.codecs.lucene42.Lucene42Codec Only for reading old 4.2 segments
org.apache.lucene.codecs.lucene42.Lucene42DocValuesFormat Only for reading old 4.2 segments
org.apache.lucene.codecs.lucene42.Lucene42FieldInfosFormat Only for reading old 4.2-4.5 segments
org.apache.lucene.codecs.lucene45.Lucene45Codec Only for reading old 4.3-4.5 segments
org.apache.lucene.codecs.lucene45.Lucene45DocValuesFormat Only for reading old 4.3-4.5 segments
org.apache.lucene.codecs.lucene46.Lucene46Codec Only for reading old 4.6-4.8 segments
org.apache.lucene.document.PackedLongDocValuesField use NumericDocValuesField instead.
org.apache.lucene.document.ShortDocValuesField use NumericDocValuesField instead.
org.apache.lucene.document.SortedBytesDocValuesField Use SortedDocValuesField instead.
org.apache.lucene.document.StraightBytesDocValuesField Use BinaryDocValuesField instead.
org.apache.lucene.analysis.Token This class is outdated and no longer used since Lucene 2.9. Nuke it finally!

Deprecated Enums

Enum and Description
org.apache.lucene.document.Field.Index This is here only to ease transition from the pre-4.0 APIs.
org.apache.lucene.document.Field.TermVector This is here only to ease transition from the pre-4.0 APIs.

Deprecated Fields

Field and Description
org.apache.lucene.util.IOUtils.CHARSET_UTF_8 Use StandardCharsets.UTF_8 instead.
org.apache.lucene.util.AttributeSource.DEFAULT_ATTRIBUTE_FACTORY use AttributeFactory.DEFAULT_ATTRIBUTE_FACTORY
org.apache.lucene.search.FieldCache.DEFAULT_BYTE_PARSER
org.apache.lucene.search.FieldCache.DEFAULT_DOUBLE_PARSER
org.apache.lucene.search.FieldCache.DEFAULT_FLOAT_PARSER
org.apache.lucene.search.FieldCache.DEFAULT_INT_PARSER
org.apache.lucene.search.FieldCache.DEFAULT_LONG_PARSER
org.apache.lucene.store.FSDirectory.DEFAULT_READ_CHUNK_SIZE This constant is no longer used since Lucene 4.5.
org.apache.lucene.search.FieldCache.DEFAULT_SHORT_PARSER
org.apache.lucene.search.FuzzyQuery.defaultMinSimilarity pass integer edit distances instead.
org.apache.lucene.util.Constants.JRE_IS_MINIMUM_JAVA6 With Lucene 4.0, we are always on Java 6
org.apache.lucene.util.Constants.JRE_IS_MINIMUM_JAVA7 With Lucene 4.8, we are always on Java 7
org.apache.lucene.util.Version.LUCENE_3_0 Bad naming of constant; use Version.LUCENE_3_0_0 instead.
org.apache.lucene.util.Version.LUCENE_3_0_0 (4.0) Use latest
org.apache.lucene.util.Version.LUCENE_3_1 Bad naming of constant; use Version.LUCENE_3_1_0 instead.
org.apache.lucene.util.Version.LUCENE_3_1_0 (4.0) Use latest
org.apache.lucene.util.Version.LUCENE_3_2 Bad naming of constant; use Version.LUCENE_3_2_0 instead.
org.apache.lucene.util.Version.LUCENE_3_2_0 (4.0) Use latest
org.apache.lucene.util.Version.LUCENE_3_3 Bad naming of constant; use Version.LUCENE_3_3_0 instead.
org.apache.lucene.util.Version.LUCENE_3_3_0 (4.0) Use latest
org.apache.lucene.util.Version.LUCENE_3_4 Bad naming of constant; use Version.LUCENE_3_4_0 instead.
org.apache.lucene.util.Version.LUCENE_3_4_0 (4.0) Use latest
org.apache.lucene.util.Version.LUCENE_3_5 Bad naming of constant; use Version.LUCENE_3_5_0 instead.
org.apache.lucene.util.Version.LUCENE_3_5_0 (4.0) Use latest
org.apache.lucene.util.Version.LUCENE_3_6 Bad naming of constant; use Version.LUCENE_3_6_0 instead.
org.apache.lucene.util.Version.LUCENE_3_6_0 (4.0) Use latest
org.apache.lucene.util.Version.LUCENE_30 Bad naming of constant; use Version.LUCENE_3_0_0 instead.
org.apache.lucene.util.Version.LUCENE_31 Bad naming of constant; use Version.LUCENE_3_1_0 instead.
org.apache.lucene.util.Version.LUCENE_32 Bad naming of constant; use Version.LUCENE_3_2_0 instead.
org.apache.lucene.util.Version.LUCENE_33 Bad naming of constant; use Version.LUCENE_3_3_0 instead.
org.apache.lucene.util.Version.LUCENE_34 Bad naming of constant; use Version.LUCENE_3_4_0 instead.
org.apache.lucene.util.Version.LUCENE_35 Bad naming of constant; use Version.LUCENE_3_5_0 instead.
org.apache.lucene.util.Version.LUCENE_36 Bad naming of constant; use Version.LUCENE_3_6_0 instead.
org.apache.lucene.util.Version.LUCENE_4_0 Bad naming of constant; use Version.LUCENE_4_0_0 instead (this constant actually points to Version.LUCENE_4_0_0_ALPHA to match whole 4.0 series).
org.apache.lucene.util.Version.LUCENE_4_0_0 (4.1) Use latest
org.apache.lucene.util.Version.LUCENE_4_0_0_ALPHA (4.1) Use latest
org.apache.lucene.util.Version.LUCENE_4_0_0_BETA (4.1) Use latest
org.apache.lucene.util.Version.LUCENE_4_1 Bad naming of constant; use Version.LUCENE_4_1_0 instead.
org.apache.lucene.util.Version.LUCENE_4_1_0 (4.2) Use latest
org.apache.lucene.util.Version.LUCENE_4_10_0 Use latest
org.apache.lucene.util.Version.LUCENE_4_10_1 Use latest
org.apache.lucene.util.Version.LUCENE_4_2 Bad naming of constant; use Version.LUCENE_4_2_0 instead.
org.apache.lucene.util.Version.LUCENE_4_2_0 (4.3) Use latest
org.apache.lucene.util.Version.LUCENE_4_2_1 (4.3) Use latest
org.apache.lucene.util.Version.LUCENE_4_3 Bad naming of constant; use Version.LUCENE_4_3_0 instead.
org.apache.lucene.util.Version.LUCENE_4_3_0 (4.4) Use latest
org.apache.lucene.util.Version.LUCENE_4_3_1 (4.6) Use latest
org.apache.lucene.util.Version.LUCENE_4_4 Bad naming of constant; use Version.LUCENE_4_4_0 instead.
org.apache.lucene.util.Version.LUCENE_4_4_0 (4.7) Use latest
org.apache.lucene.util.Version.LUCENE_4_5 Bad naming of constant; use Version.LUCENE_4_5_0 instead.
org.apache.lucene.util.Version.LUCENE_4_5_0 (5.0) Use latest
org.apache.lucene.util.Version.LUCENE_4_5_1 (5.0) Use latest
org.apache.lucene.util.Version.LUCENE_4_6 Bad naming of constant; use Version.LUCENE_4_6_0 instead.
org.apache.lucene.util.Version.LUCENE_4_6_0 (5.0) Use latest
org.apache.lucene.util.Version.LUCENE_4_6_1 (5.0) Use latest
org.apache.lucene.util.Version.LUCENE_4_7 Bad naming of constant; use Version.LUCENE_4_7_0 instead.
org.apache.lucene.util.Version.LUCENE_4_7_0 (4.8) Use latest
org.apache.lucene.util.Version.LUCENE_4_7_1 (5.0) Use latest
org.apache.lucene.util.Version.LUCENE_4_7_2 (5.0) Use latest
org.apache.lucene.util.Version.LUCENE_4_8 Bad naming of constant; use Version.LUCENE_4_8_0 instead.
org.apache.lucene.util.Version.LUCENE_4_8_0 (4.9) Use latest
org.apache.lucene.util.Version.LUCENE_4_8_1 (4.10) Use latest
org.apache.lucene.util.Version.LUCENE_4_9 Bad naming of constant; use Version.LUCENE_4_9_0 instead.
org.apache.lucene.util.Version.LUCENE_4_9_0 (5.0) Use latest
org.apache.lucene.util.Version.LUCENE_4_9_1 (5.0) Use latest
org.apache.lucene.util.Version.LUCENE_40 Bad naming of constant; use Version.LUCENE_4_0_0 instead (this constant actually points to Version.LUCENE_4_0_0_ALPHA to match whole 4.0 series).
org.apache.lucene.util.Version.LUCENE_41 Bad naming of constant; use Version.LUCENE_4_1_0 instead.
org.apache.lucene.util.Version.LUCENE_42 Bad naming of constant; use Version.LUCENE_4_2_0 instead.
org.apache.lucene.util.Version.LUCENE_43 Bad naming of constant; use Version.LUCENE_4_3_0 instead.
org.apache.lucene.util.Version.LUCENE_44 Bad naming of constant; use Version.LUCENE_4_4_0 instead.
org.apache.lucene.util.Version.LUCENE_45 Bad naming of constant; use Version.LUCENE_4_5_0 instead.
org.apache.lucene.util.Version.LUCENE_46 Bad naming of constant; use Version.LUCENE_4_6_0 instead.
org.apache.lucene.util.Version.LUCENE_47 Bad naming of constant; use Version.LUCENE_4_7_0 instead.
org.apache.lucene.util.Version.LUCENE_48 Bad naming of constant; use Version.LUCENE_4_8_0 instead.
org.apache.lucene.util.Version.LUCENE_CURRENT Use Version.LATEST
org.apache.lucene.util.Constants.LUCENE_MAIN_VERSION Use Version.LATEST
org.apache.lucene.util.Constants.LUCENE_VERSION Use Version.LATEST

Deprecated Methods

Method and Description
org.apache.lucene.util.BytesRef.append(BytesRef) BytesRef should not be used as a buffer, use BytesRefBuilder instead
org.apache.lucene.util.CharsRef.append(char[], int, int) CharsRef should not be used as a buffer, use CharsRefBuilder instead
org.apache.lucene.index.SegmentInfo.attributes() no longer supported
org.apache.lucene.codecs.CodecUtil.checkEOF(IndexInput) Use CodecUtil.checkFooter(org.apache.lucene.store.ChecksumIndexInput) instead, this should only used for files without checksums
org.apache.lucene.index.IndexWriter.close(boolean) To abort merges and then close, call IndexWriter.commit() and then IndexWriter.rollback() instead.
org.apache.lucene.util.BytesRef.copyBytes(BytesRef) BytesRef should not be used as a buffer, use BytesRefBuilder instead
org.apache.lucene.util.CharsRef.copyChars(char[], int, int) CharsRef should not be used as a buffer, use CharsRefBuilder instead
org.apache.lucene.util.BytesRef.copyChars(CharSequence) BytesRef should not be used as a buffer, use BytesRefBuilder instead
org.apache.lucene.util.CharsRef.copyChars(CharsRef) CharsRef should not be used as a buffer, use CharsRefBuilder instead
org.apache.lucene.util.IntsRef.copyInts(IntsRef) IntsRef should not be used as a buffer, use IntsRefBuilder instead
org.apache.lucene.search.IndexSearcher.document(int, Set) Use IndexSearcher.doc(int, Set) instead.
org.apache.lucene.store.Directory.fileExists(String) This method will be removed in 5.0
org.apache.lucene.search.FuzzyQuery.floatToEdits(float, int) pass integer edit distances instead.
org.apache.lucene.store.IndexOutput.flush() Lucene never calls this method.
org.apache.lucene.index.SegmentInfo.getAttribute(String) no longer supported
org.apache.lucene.search.FieldCache.getBytes(AtomicReader, String, boolean) (4.4) Index as a numeric field using IntField and then use FieldCache.getInts(AtomicReader, String, boolean) instead.
org.apache.lucene.search.FieldCache.getBytes(AtomicReader, String, FieldCache.ByteParser, boolean) (4.4) Index as a numeric field using IntField and then use FieldCache.getInts(AtomicReader, String, boolean) instead.
org.apache.lucene.store.FSDirectory.getReadChunkSize() This is no longer used since Lucene 4.5.
org.apache.lucene.search.FieldCache.getShorts(AtomicReader, String, boolean) (4.4) Index as a numeric field using IntField and then use FieldCache.getInts(AtomicReader, String, boolean) instead.
org.apache.lucene.search.FieldCache.getShorts(AtomicReader, String, FieldCache.ShortParser, boolean) (4.4) Index as a numeric field using IntField and then use FieldCache.getInts(AtomicReader, String, boolean) instead.
org.apache.lucene.index.Fields.getUniqueTermCount() iterate fields and add their size() instead. this method is only provided as a transition mechanism to access this statistic for 3.x indexes, which do not have this statistic per-field.
org.apache.lucene.util.CharsRef.getUTF16SortedAsUTF8Comparator() This comparator is only a transition mechanism
org.apache.lucene.util.BytesRef.getUTF8SortedAsUTF16Comparator() This comparator is only a transition mechanism
org.apache.lucene.util.IntsRef.grow(int) IntsRef should not be used as a buffer, use IntsRefBuilder instead
org.apache.lucene.util.BytesRef.grow(int) BytesRef should not be used as a buffer, use BytesRefBuilder instead
org.apache.lucene.util.CharsRef.grow(int) CharsRef should not be used as a buffer, use CharsRefBuilder instead
org.apache.lucene.index.AtomicReader.hasNorms(String) (4.0) use AtomicReader.getFieldInfos() and check FieldInfo.hasNorms() for the field instead.
org.apache.lucene.store.IndexOutput.length() Use IndexOutput.getFilePointer() instead; this method will be removed in Lucene5.0.
org.apache.lucene.search.FieldCacheRangeFilter.newByteRange(String, Byte, Byte, boolean, boolean)
org.apache.lucene.search.FieldCacheRangeFilter.newByteRange(String, FieldCache.ByteParser, Byte, Byte, boolean, boolean)
org.apache.lucene.search.FieldCacheRangeFilter.newShortRange(String, FieldCache.ShortParser, Short, Short, boolean, boolean)
org.apache.lucene.search.FieldCacheRangeFilter.newShortRange(String, Short, Short, boolean, boolean)
org.apache.lucene.index.IndexReader.open(Directory) Use DirectoryReader.open(Directory)
org.apache.lucene.index.IndexReader.open(Directory, int) Use DirectoryReader.open(Directory,int)
org.apache.lucene.index.IndexReader.open(IndexCommit) Use DirectoryReader.open(IndexCommit)
org.apache.lucene.index.IndexReader.open(IndexCommit, int) Use DirectoryReader.open(IndexCommit,int)
org.apache.lucene.index.IndexReader.open(IndexWriter, boolean) Use DirectoryReader.open(IndexWriter,boolean)
org.apache.lucene.index.SegmentInfo.putAttribute(String, String) no longer supported
org.apache.lucene.index.IndexWriter.ramSizeInBytes() use #ramBytesUsed() instead
org.apache.lucene.index.SegmentCommitInfo.setGenUpdatesFiles(Map>) required to support 4.6-4.8 indexes.
org.apache.lucene.store.FSDirectory.setReadChunkSize(int) This is no longer used since Lucene 4.5.
org.apache.lucene.document.Field.translateFieldType(Field.Store, Field.Index, Field.TermVector) This is here only to ease transition from the pre-4.0 APIs.
org.apache.lucene.util.UnicodeUtil.UTF16toUTF8(CharSequence, BytesRef) Uses BytesRef as a buffer.
org.apache.lucene.util.UnicodeUtil.UTF8toUTF16(BytesRef, CharsRef) Uses CharsRef as a buffer.
org.apache.lucene.index.SegmentInfos.write3xInfo(Directory, SegmentInfo, IOContext)

Deprecated Constructors

Constructor and Description
org.apache.lucene.analysis.Analyzer.GlobalReuseStrategy() Don't create instances of this class, use Analyzer.GLOBAL_REUSE_STRATEGY
org.apache.lucene.analysis.Analyzer.PerFieldReuseStrategy() Don't create instances of this class, use Analyzer.PER_FIELD_REUSE_STRATEGY
org.apache.lucene.analysis.AnalyzerWrapper() Use AnalyzerWrapper.AnalyzerWrapper(Analyzer.ReuseStrategy) and specify a valid Analyzer.ReuseStrategy, probably retrieved from the wrapped analyzer using Analyzer.getReuseStrategy().
org.apache.lucene.document.Field(String, byte[]) Use StoredField instead.
org.apache.lucene.document.Field(String, byte[], int, int) Use StoredField instead.
org.apache.lucene.document.Field(String, Reader) Use TextField instead.
org.apache.lucene.document.Field(String, Reader, Field.TermVector) Use TextField instead.
org.apache.lucene.document.Field(String, String, Field.Store, Field.Index) Use StringField, TextField instead.
org.apache.lucene.document.Field(String, String, Field.Store, Field.Index, Field.TermVector) Use StringField, TextField instead.
org.apache.lucene.document.Field(String, TokenStream) Use TextField instead
org.apache.lucene.document.Field(String, TokenStream, Field.TermVector) Use TextField instead

Deprecated Enum Constants

Enum Constant and Description
org.apache.lucene.search.SortField.Type.BYTE
org.apache.lucene.search.SortField.Type.SHORT