## Uses of Class
org.apache.lucene.util.BytesRef

Packages that use BytesRef
Package | Description
--- | ---
org.apache.lucene.analysis | API and code to convert text into indexable/searchable tokens.
org.apache.lucene.analysis.tokenattributes | General-purpose attributes for text analysis.
org.apache.lucene.codecs | Codecs API: API for customization of the encoding and structure of the index.
org.apache.lucene.codecs.compressing | StoredFieldsFormat that allows cross-document and cross-field compression of stored fields.
org.apache.lucene.codecs.lucene40 | Lucene 4.0 file format.
org.apache.lucene.codecs.lucene41 | Lucene 4.1 file format.
org.apache.lucene.document | The logical representation of a `Document` for indexing and searching.
org.apache.lucene.index | Code to maintain and access indices.
org.apache.lucene.search | Code to search indices.
org.apache.lucene.search.payloads | The payloads package provides Query mechanisms for finding and using payloads.
org.apache.lucene.search.similarities | This package contains the various ranking models that can be used in Lucene.
org.apache.lucene.util | Some utility classes.
org.apache.lucene.util.automaton | Finite-state automaton for regular expressions.
org.apache.lucene.util.fst | Finite state transducers
org.apache.lucene.util.mutable | Comparable object wrappers

### Uses of BytesRef in org.apache.lucene.analysis

Methods in org.apache.lucene.analysis that return BytesRef
Modifier and Type | Method and Description
--- | ---
`protected BytesRef` | TokenStreamToAutomaton.`changeToken(BytesRef in)` Subclass & implement this if you need to change the token (such as escaping certain bytes) before it's turned into a graph.
`BytesRef` | NumericTokenStream.NumericTermAttributeImpl.`getBytesRef()`
`BytesRef` | Token.`getPayload()` Returns this Token's payload.

Methods in org.apache.lucene.analysis with parameters of type BytesRef
Modifier and Type | Method and Description
--- | ---
`protected BytesRef` | TokenStreamToAutomaton.`changeToken(BytesRef in)` Subclass & implement this if you need to change the token (such as escaping certain bytes) before it's turned into a graph.
`void` | Token.`setPayload(BytesRef payload)` Sets this Token's payload.

### Uses of BytesRef in org.apache.lucene.analysis.tokenattributes

Methods in org.apache.lucene.analysis.tokenattributes that return BytesRef
Modifier and Type | Method and Description
--- | ---
`BytesRef` | TermToBytesRefAttribute.`getBytesRef()` Retrieve this attribute's BytesRef.
`BytesRef` | CharTermAttributeImpl.`getBytesRef()`
`BytesRef` | PayloadAttributeImpl.`getPayload()`
`BytesRef` | PayloadAttribute.`getPayload()` Returns this Token's payload.

Methods in org.apache.lucene.analysis.tokenattributes with parameters of type BytesRef
Modifier and Type | Method and Description
--- | ---
`void` | PayloadAttributeImpl.`setPayload(BytesRef payload)`
`void` | PayloadAttribute.`setPayload(BytesRef payload)` Sets this Token's payload.

Constructors in org.apache.lucene.analysis.tokenattributes with parameters of type BytesRef
Constructor and Description
`PayloadAttributeImpl(BytesRef payload)` Initialize this attribute with the given payload.

### Uses of BytesRef in org.apache.lucene.codecs

Methods in org.apache.lucene.codecs that return BytesRef
Modifier and Type | Method and Description
--- | ---
`BytesRef` | MappingMultiDocsAndPositionsEnum.`getPayload()`

Methods in org.apache.lucene.codecs that return types with arguments of type BytesRef
Modifier and Type | Method and Description
--- | ---
`abstract Comparator<BytesRef>` | TermVectorsWriter.`getComparator()` Return the BytesRef Comparator used to sort terms before feeding to this API.
`abstract Comparator<BytesRef>` | TermsConsumer.`getComparator()` Return the BytesRef Comparator used to sort terms before feeding to this API.
`Comparator<BytesRef>` | BlockTreeTermsReader.FieldReader.`getComparator()`

Methods in org.apache.lucene.codecs with parameters of type BytesRef
Modifier and Type | Method and Description
--- | ---
`abstract void` | PostingsConsumer.`addPosition(int position, BytesRef payload, int startOffset, int endOffset)` Add a new position & payload, and start/end offset.
`abstract void` | TermVectorsWriter.`addPosition(int position, int startOffset, int endOffset, BytesRef payload)` Adds a term position and offsets
`abstract void` | TermsConsumer.`finishTerm(BytesRef text, TermStats stats)` Finishes the current term; numDocs must be > 0.
`TermsEnum` | BlockTreeTermsReader.FieldReader.`intersect(CompiledAutomaton compiled, BytesRef startTerm)`
`abstract PostingsConsumer` | TermsConsumer.`startTerm(BytesRef text)` Starts a new term in this field; this may be called with no corresponding call to finish if the term had no docs.
`abstract void` | TermVectorsWriter.`startTerm(BytesRef term, int freq)` Adds a term and its term frequency `freq`.

Method parameters in org.apache.lucene.codecs with type arguments of type BytesRef
Modifier and Type | Method and Description
--- | ---
`abstract void` | DocValuesConsumer.`addBinaryField(FieldInfo field, Iterable<BytesRef> values)` Writes binary docvalues for a field.
`abstract void` | DocValuesConsumer.`addSortedField(FieldInfo field, Iterable<BytesRef> values, Iterable<Number> docToOrd)` Writes pre-sorted binary docvalues for a field.
`abstract void` | DocValuesConsumer.`addSortedSetField(FieldInfo field, Iterable<BytesRef> values, Iterable<Number> docToOrdCount, Iterable<Number> ords)` Writes pre-sorted set docvalues for a field

### Uses of BytesRef in org.apache.lucene.codecs.compressing

Methods in org.apache.lucene.codecs.compressing that return types with arguments of type BytesRef
Modifier and Type | Method and Description
--- | ---
`Comparator<BytesRef>` | CompressingTermVectorsWriter.`getComparator()`

Methods in org.apache.lucene.codecs.compressing with parameters of type BytesRef
Modifier and Type | Method and Description
--- | ---
`void` | CompressingTermVectorsWriter.`addPosition(int position, int startOffset, int endOffset, BytesRef payload)`
`abstract void` | Decompressor.`decompress(DataInput in, int originalLength, int offset, int length, BytesRef bytes)` Decompress bytes that were stored between offsets `offset` and `offset+length` in the original stream from the compressed stream `in` to `bytes`.
`void` | CompressingTermVectorsWriter.`startTerm(BytesRef term, int freq)`

### Uses of BytesRef in org.apache.lucene.codecs.lucene40

Methods in org.apache.lucene.codecs.lucene40 that return types with arguments of type BytesRef
Modifier and Type | Method and Description
--- | ---
`Comparator<BytesRef>` | Lucene40TermVectorsWriter.`getComparator()`

Methods in org.apache.lucene.codecs.lucene40 with parameters of type BytesRef
Modifier and Type | Method and Description
--- | ---
`void` | Lucene40TermVectorsWriter.`addPosition(int position, int startOffset, int endOffset, BytesRef payload)`
`void` | Lucene40TermVectorsWriter.`startTerm(BytesRef term, int freq)`

### Uses of BytesRef in org.apache.lucene.codecs.lucene41

Methods in org.apache.lucene.codecs.lucene41 with parameters of type BytesRef
Modifier and Type | Method and Description
--- | ---
`void` | Lucene41PostingsWriter.`addPosition(int position, BytesRef payload, int startOffset, int endOffset)` Add a new position & payload

### Uses of BytesRef in org.apache.lucene.document

Methods in org.apache.lucene.document that return BytesRef
Modifier and Type | Method and Description
--- | ---
`BytesRef` | Field.`binaryValue()`
`BytesRef` | Document.`getBinaryValue(String name)` Returns an array of bytes for the first (or only) field that has the name specified as the method parameter.
`BytesRef[]` | Document.`getBinaryValues(String name)` Returns an array of byte arrays for of the fields that have the name specified as the method parameter.

Methods in org.apache.lucene.document with parameters of type BytesRef
Modifier and Type | Method and Description
--- | ---
`static byte[]` | CompressionTools.`decompress(BytesRef bytes)` Decompress the byte array previously returned by compress (referenced by the provided BytesRef)
`static String` | CompressionTools.`decompressString(BytesRef bytes)` Decompress the byte array (referenced by the provided BytesRef) previously returned by compressString back into a String
`void` | Field.`setBytesValue(BytesRef value)` Expert: change the value of this field.

Constructors in org.apache.lucene.document with parameters of type BytesRef
Constructor and Description
`BinaryDocValuesField(String name, BytesRef value)` Create a new binary DocValues field.
`DerefBytesDocValuesField(String name, BytesRef bytes)` Deprecated. Create a new fixed or variable-length DocValues field.
`DerefBytesDocValuesField(String name, BytesRef bytes, boolean isFixedLength)` Deprecated. Create a new fixed or variable length DocValues field.
`Field(String name, BytesRef bytes, FieldType type)` Create field with binary value.
`SortedBytesDocValuesField(String name, BytesRef bytes)` Deprecated. Create a new fixed or variable-length sorted DocValues field.
`SortedBytesDocValuesField(String name, BytesRef bytes, boolean isFixedLength)` Deprecated. Create a new fixed or variable length sorted DocValues field.
`SortedDocValuesField(String name, BytesRef bytes)` Create a new sorted DocValues field.
`SortedSetDocValuesField(String name, BytesRef bytes)` Create a new sorted DocValues field.
`StoredField(String name, BytesRef value)` Create a stored-only field with the given binary value.
`StraightBytesDocValuesField(String name, BytesRef bytes)` Deprecated. Create a new fixed or variable length DocValues field.
`StraightBytesDocValuesField(String name, BytesRef bytes, boolean isFixedLength)` Deprecated. Create a new fixed or variable length direct DocValues field.

### Uses of BytesRef in org.apache.lucene.index

Fields in org.apache.lucene.index declared as BytesRef
Modifier and Type | Field and Description
--- | ---
`protected BytesRef[]` | DocTermOrds.`indexedTermsArray` Holds the indexed (by default every 128th) terms.
`protected BytesRef` | DocTermOrds.`prefix` If non-null, only terms matching this prefix were indexed.

Methods in org.apache.lucene.index that return BytesRef
Modifier and Type | Method and Description
--- | ---
`BytesRef` | IndexableField.`binaryValue()` Non-null if this field has a binary value
`BytesRef` | Term.`bytes()` Returns the bytes of this term.
`BytesRef` | MultiDocsAndPositionsEnum.`getPayload()`
`BytesRef` | FilterAtomicReader.FilterDocsAndPositionsEnum.`getPayload()`
`abstract BytesRef` | DocsAndPositionsEnum.`getPayload()` Returns the payload at this position, or null if no payload was indexed.
`BytesRef` | DocTermOrds.`lookupTerm(TermsEnum termsEnum, int ord)` Returns the term (`BytesRef`) corresponding to the provided ordinal.
`BytesRef` | SortedSetDocValuesTermsEnum.`next()`
`BytesRef` | SortedDocValuesTermsEnum.`next()`
`BytesRef` | MultiTermsEnum.`next()`
`BytesRef` | FilteredTermsEnum.`next()`
`BytesRef` | FilterAtomicReader.FilterTermsEnum.`next()`
`protected BytesRef` | FilteredTermsEnum.`nextSeekTerm(BytesRef currentTerm)` On the first call to `FilteredTermsEnum.next()` or if `FilteredTermsEnum.accept(org.apache.lucene.util.BytesRef)` returns `FilteredTermsEnum.AcceptStatus.YES_AND_SEEK` or `FilteredTermsEnum.AcceptStatus.NO_AND_SEEK`, this method will be called to eventually seek the underlying TermsEnum to a new position.
`abstract BytesRef` | TermsEnum.`term()` Returns current term.
`BytesRef` | SortedSetDocValuesTermsEnum.`term()`
`BytesRef` | SortedDocValuesTermsEnum.`term()`
`BytesRef` | MultiTermsEnum.`term()`
`BytesRef` | FilteredTermsEnum.`term()`
`BytesRef` | FilterAtomicReader.FilterTermsEnum.`term()`

Methods in org.apache.lucene.index that return types with arguments of type BytesRef
Modifier and Type | Method and Description
--- | ---
`abstract Comparator<BytesRef>` | Terms.`getComparator()` Return the BytesRef Comparator used to sort terms provided by the iterator.
`Comparator<BytesRef>` | SortedSetDocValuesTermsEnum.`getComparator()`
`Comparator<BytesRef>` | SortedDocValuesTermsEnum.`getComparator()`
`Comparator<BytesRef>` | MultiTermsEnum.`getComparator()`
`Comparator<BytesRef>` | MultiTerms.`getComparator()`
`Comparator<BytesRef>` | FilteredTermsEnum.`getComparator()`
`Comparator<BytesRef>` | FilterAtomicReader.FilterTerms.`getComparator()`
`Comparator<BytesRef>` | FilterAtomicReader.FilterTermsEnum.`getComparator()`

Methods in org.apache.lucene.index with parameters of type BytesRef
Modifier and Type | Method and Description
--- | ---
`protected FilteredTermsEnum.AcceptStatus` | SingleTermsEnum.`accept(BytesRef term)`
`protected abstract FilteredTermsEnum.AcceptStatus` | FilteredTermsEnum.`accept(BytesRef term)` Return if term is accepted, not accepted or the iteration should ended (and possibly seek).
`void` | SortedDocValues.`get(int docID, BytesRef result)`
`abstract void` | BinaryDocValues.`get(int docID, BytesRef result)` Lookup the value for document.
`static DocsEnum` | MultiFields.`getTermDocsEnum(IndexReader r, Bits liveDocs, String field, BytesRef term)` Returns `DocsEnum` for the specified field & term.
`static DocsEnum` | MultiFields.`getTermDocsEnum(IndexReader r, Bits liveDocs, String field, BytesRef term, int flags)` Returns `DocsEnum` for the specified field & term, with control over whether freqs are required.
`static DocsAndPositionsEnum` | MultiFields.`getTermPositionsEnum(IndexReader r, Bits liveDocs, String field, BytesRef term)` Returns `DocsAndPositionsEnum` for the specified field & term.
`static DocsAndPositionsEnum` | MultiFields.`getTermPositionsEnum(IndexReader r, Bits liveDocs, String field, BytesRef term, int flags)` Returns `DocsAndPositionsEnum` for the specified field & term, with control over whether offsets and payloads are required.
`TermsEnum` | Terms.`intersect(CompiledAutomaton compiled, BytesRef startTerm)` Returns a TermsEnum that iterates over all terms that are accepted by the provided `CompiledAutomaton`.
`TermsEnum` | MultiTerms.`intersect(CompiledAutomaton compiled, BytesRef startTerm)`
`TermsEnum` | FilterAtomicReader.FilterTerms.`intersect(CompiledAutomaton automaton, BytesRef bytes)`
`abstract void` | SortedDocValues.`lookupOrd(int ord, BytesRef result)` Retrieves the value for the specified ordinal.
`void` | MultiDocValues.MultiSortedDocValues.`lookupOrd(int ord, BytesRef result)`
`abstract void` | SortedSetDocValues.`lookupOrd(long ord, BytesRef result)` Retrieves the value for the specified ordinal.
`void` | SingletonSortedSetDocValues.`lookupOrd(long ord, BytesRef result)`
`void` | MultiDocValues.MultiSortedSetDocValues.`lookupOrd(long ord, BytesRef result)`
`long` | SortedSetDocValues.`lookupTerm(BytesRef key)` If `key` exists, returns its ordinal, else returns `-insertionPoint-1`, like `Arrays.binarySearch`.
`int` | SortedDocValues.`lookupTerm(BytesRef key)` If `key` exists, returns its ordinal, else returns `-insertionPoint-1`, like `Arrays.binarySearch`.
`long` | SingletonSortedSetDocValues.`lookupTerm(BytesRef key)`
`protected BytesRef` | FilteredTermsEnum.`nextSeekTerm(BytesRef currentTerm)` On the first call to `FilteredTermsEnum.next()` or if `FilteredTermsEnum.accept(org.apache.lucene.util.BytesRef)` returns `FilteredTermsEnum.AcceptStatus.YES_AND_SEEK` or `FilteredTermsEnum.AcceptStatus.NO_AND_SEEK`, this method will be called to eventually seek the underlying TermsEnum to a new position.
`TermsEnum.SeekStatus` | TermsEnum.`seekCeil(BytesRef text)` Seeks to the specified term, if it exists, or to the next (ceiling) term.
`abstract TermsEnum.SeekStatus` | TermsEnum.`seekCeil(BytesRef text, boolean useCache)` Expert: just like `TermsEnum.seekCeil(BytesRef)` but allows you to control whether the implementation should attempt to use its term cache (if it uses one).
`TermsEnum.SeekStatus` | SortedSetDocValuesTermsEnum.`seekCeil(BytesRef text, boolean useCache)`
`TermsEnum.SeekStatus` | SortedDocValuesTermsEnum.`seekCeil(BytesRef text, boolean useCache)`
`TermsEnum.SeekStatus` | MultiTermsEnum.`seekCeil(BytesRef term, boolean useCache)`
`TermsEnum.SeekStatus` | FilteredTermsEnum.`seekCeil(BytesRef term, boolean useCache)` This enum does not support seeking!
`TermsEnum.SeekStatus` | FilterAtomicReader.FilterTermsEnum.`seekCeil(BytesRef text, boolean useCache)`
`boolean` | TermsEnum.`seekExact(BytesRef text, boolean useCache)` Attempts to seek to the exact term, returning true if the term is found.
`boolean` | SortedSetDocValuesTermsEnum.`seekExact(BytesRef text, boolean useCache)`
`boolean` | SortedDocValuesTermsEnum.`seekExact(BytesRef text, boolean useCache)`
`boolean` | MultiTermsEnum.`seekExact(BytesRef term, boolean useCache)`
`boolean` | FilteredTermsEnum.`seekExact(BytesRef term, boolean useCache)` This enum does not support seeking!
`boolean` | FilterAtomicReader.FilterTermsEnum.`seekExact(BytesRef text, boolean useCache)`
`void` | TermsEnum.`seekExact(BytesRef term, TermState state)` Expert: Seeks a specific position by `TermState` previously obtained from `TermsEnum.termState()`.
`void` | SortedSetDocValuesTermsEnum.`seekExact(BytesRef term, TermState state)`
`void` | SortedDocValuesTermsEnum.`seekExact(BytesRef term, TermState state)`
`void` | FilteredTermsEnum.`seekExact(BytesRef term, TermState state)` This enum does not support seeking!
`void` | FilterAtomicReader.FilterTermsEnum.`seekExact(BytesRef term, TermState state)`
`protected void` | FilteredTermsEnum.`setInitialSeekTerm(BytesRef term)` Use this method to set the initial `BytesRef` to seek before iterating.
`static long` | MultiFields.`totalTermFreq(IndexReader r, String field, BytesRef text)` Returns the total number of occurrences of this term across all documents (the sum of the freq() for each doc that has this term).
`protected void` | DocTermOrds.`uninvert(AtomicReader reader, Bits liveDocs, BytesRef termPrefix)` Call this only once (if you subclass!)

Constructors in org.apache.lucene.index with parameters of type BytesRef
Constructor and Description
`DocTermOrds(AtomicReader reader, Bits liveDocs, String field, BytesRef termPrefix)` Inverts only terms starting w/ prefix
`DocTermOrds(AtomicReader reader, Bits liveDocs, String field, BytesRef termPrefix, int maxTermDocFreq)` Inverts only terms starting w/ prefix, and only terms whose docFreq (not taking deletions into account) is <= maxTermDocFreq
`DocTermOrds(AtomicReader reader, Bits liveDocs, String field, BytesRef termPrefix, int maxTermDocFreq, int indexIntervalBits)` Inverts only terms starting w/ prefix, and only terms whose docFreq (not taking deletions into account) is <= maxTermDocFreq, with a custom indexing interval (default is every 128nd term).
`SingleTermsEnum(TermsEnum tenum, BytesRef termText)` Creates a new `SingleTermsEnum`.
`Term(String fld, BytesRef bytes)` Constructs a Term with the given field and bytes.

### Uses of BytesRef in org.apache.lucene.search

Methods in org.apache.lucene.search that return BytesRef
Modifier and Type | Method and Description
--- | ---
`BytesRef` | MaxNonCompetitiveBoostAttributeImpl.`getCompetitiveTerm()`
`BytesRef` | MaxNonCompetitiveBoostAttribute.`getCompetitiveTerm()` This is the term or `null` of the term that triggered the boost change.
`BytesRef` | TermRangeQuery.`getLowerTerm()` Returns the lower value of this range query
`BytesRef` | TermRangeFilter.`getLowerTerm()` Returns the lower value of this range filter
`BytesRef` | DocTermOrdsRangeFilter.`getLowerVal()` Returns the lower value of this range filter
`BytesRef` | TermRangeQuery.`getUpperTerm()` Returns the upper value of this range query
`BytesRef` | TermRangeFilter.`getUpperTerm()` Returns the upper value of this range filter
`BytesRef` | DocTermOrdsRangeFilter.`getUpperVal()` Returns the upper value of this range filter
`BytesRef` | FuzzyTermsEnum.`next()`
`BytesRef` | TermStatistics.`term()` returns the term text
`BytesRef` | FuzzyTermsEnum.`term()`
`BytesRef` | FieldComparator.TermOrdValComparator.`value(int slot)`
`BytesRef` | FieldComparator.TermValComparator.`value(int slot)`

Methods in org.apache.lucene.search that return types with arguments of type BytesRef
Modifier and Type | Method and Description
--- | ---
`Comparator<BytesRef>` | SortField.`getBytesComparator()`
`Comparator<BytesRef>` | FuzzyTermsEnum.`getComparator()`
`static FieldCacheRangeFilter<BytesRef>` | FieldCacheRangeFilter.`newBytesRefRange(String field, BytesRef lowerVal, BytesRef upperVal, boolean includeLower, boolean includeUpper)` Creates a BytesRef range filter using `FieldCache.getTermsIndex(org.apache.lucene.index.AtomicReader, java.lang.String)`.
`FieldComparator<BytesRef>` | FieldComparator.TermOrdValComparator.`setNextReader(AtomicReaderContext context)`
`FieldComparator<BytesRef>` | FieldComparator.TermValComparator.`setNextReader(AtomicReaderContext context)`

Methods in org.apache.lucene.search with parameters of type BytesRef
Modifier and Type | Method and Description
--- | ---
`protected FilteredTermsEnum.AcceptStatus` | TermRangeTermsEnum.`accept(BytesRef term)`
`protected FilteredTermsEnum.AcceptStatus` | PrefixTermsEnum.`accept(BytesRef term)`
`int` | FieldComparator.TermOrdValComparator.`compareDocToValue(int doc, BytesRef value)`
`int` | FieldComparator.TermValComparator.`compareDocToValue(int doc, BytesRef value)`
`int` | FieldComparator.TermValComparator.`compareValues(BytesRef val1, BytesRef val2)`
`protected TermsEnum` | FuzzyTermsEnum.`getAutomatonEnum(int editDistance, BytesRef lastTerm)` return an automata-based enum for matching up to editDistance from lastTerm, if possible
`static TermRangeFilter` | TermRangeFilter.`Less(String fieldName, BytesRef upperTerm)` Constructs a filter for field `fieldName` matching less than or equal to `upperTerm`.
`protected void` | FuzzyTermsEnum.`maxEditDistanceChanged(BytesRef lastTerm, int maxEdits, boolean init)`
`static TermRangeFilter` | TermRangeFilter.`More(String fieldName, BytesRef lowerTerm)` Constructs a filter for field `fieldName` matching greater than or equal to `lowerTerm`.
`static FieldCacheRangeFilter<BytesRef>` | FieldCacheRangeFilter.`newBytesRefRange(String field, BytesRef lowerVal, BytesRef upperVal, boolean includeLower, boolean includeUpper)` Creates a BytesRef range filter using `FieldCache.getTermsIndex(org.apache.lucene.index.AtomicReader, java.lang.String)`.
`static DocTermOrdsRangeFilter` | DocTermOrdsRangeFilter.`newBytesRefRange(String field, BytesRef lowerVal, BytesRef upperVal, boolean includeLower, boolean includeUpper)` Creates a BytesRef range filter using `FieldCache.getTermsIndex(org.apache.lucene.index.AtomicReader, java.lang.String)`.
`byte` | FieldCache.ByteParser.`parseByte(BytesRef term)` Return a single Byte representation of this field's value.
`double` | FieldCache.DoubleParser.`parseDouble(BytesRef term)` Return an double representation of this field's value.
`float` | FieldCache.FloatParser.`parseFloat(BytesRef term)` Return an float representation of this field's value.
`int` | FieldCache.IntParser.`parseInt(BytesRef term)` Return an integer representation of this field's value.
`long` | FieldCache.LongParser.`parseLong(BytesRef term)` Return an long representation of this field's value.
`short` | FieldCache.ShortParser.`parseShort(BytesRef term)` Return a short representation of this field's value.
`TermsEnum.SeekStatus` | FuzzyTermsEnum.`seekCeil(BytesRef text, boolean useCache)`
`boolean` | FuzzyTermsEnum.`seekExact(BytesRef text, boolean useCache)`
`void` | FuzzyTermsEnum.`seekExact(BytesRef term, TermState state)`
`void` | MaxNonCompetitiveBoostAttributeImpl.`setCompetitiveTerm(BytesRef competitiveTerm)`
`void` | MaxNonCompetitiveBoostAttribute.`setCompetitiveTerm(BytesRef competitiveTerm)` This is the term or `null` of the term that triggered the boost change.

Method parameters in org.apache.lucene.search with type arguments of type BytesRef
Modifier and Type | Method and Description
--- | ---
`void` | SortField.`setBytesComparator(Comparator<BytesRef> b)`

Constructors in org.apache.lucene.search with parameters of type BytesRef
Constructor and Description
`FieldCacheTermsFilter(String field, BytesRef... terms)`
`PrefixTermsEnum(TermsEnum tenum, BytesRef prefixText)`
`TermRangeFilter(String fieldName, BytesRef lowerTerm, BytesRef upperTerm, boolean includeLower, boolean includeUpper)`
`TermRangeQuery(String field, BytesRef lowerTerm, BytesRef upperTerm, boolean includeLower, boolean includeUpper)` Constructs a query selecting all terms greater/equal than `lowerTerm` but less/equal than `upperTerm`.
`TermRangeTermsEnum(TermsEnum tenum, BytesRef lowerTerm, BytesRef upperTerm, boolean includeLower, boolean includeUpper)` Enumerates all terms greater/equal than `lowerTerm` but less/equal than `upperTerm`.
`TermStatistics(BytesRef term, long docFreq, long totalTermFreq)`

### Uses of BytesRef in org.apache.lucene.search.payloads

Fields in org.apache.lucene.search.payloads declared as BytesRef
Modifier and Type | Field and Description
--- | ---
`protected BytesRef` | PayloadTermQuery.PayloadTermWeight.PayloadTermSpanScorer.`payload`

### Uses of BytesRef in org.apache.lucene.search.similarities

Methods in org.apache.lucene.search.similarities with parameters of type BytesRef
Modifier and Type | Method and Description
--- | ---
`abstract float` | Similarity.SloppySimScorer.`computePayloadFactor(int doc, int start, int end, BytesRef payload)` Calculate a scoring factor based on the data in the payload.
`abstract float` | TFIDFSimilarity.`scorePayload(int doc, int start, int end, BytesRef payload)` Calculate a scoring factor based on the data in the payload.
`float` | DefaultSimilarity.`scorePayload(int doc, int start, int end, BytesRef payload)` The default implementation returns `1`
`protected float` | BM25Similarity.`scorePayload(int doc, int start, int end, BytesRef payload)` The default implementation returns `1`

### Uses of BytesRef in org.apache.lucene.util

Fields in org.apache.lucene.util declared as BytesRef
Modifier and Type | Field and Description
--- | ---
`static BytesRef` | UnicodeUtil.`BIG_TERM` A binary term consisting of a number of 0xff bytes, likely to be bigger than other terms one would normally encounter, and definitely bigger than any UTF-8 terms.

Methods in org.apache.lucene.util that return BytesRef
Modifier and Type | Method and Description
--- | ---
`BytesRef` | BytesRef.`clone()`
`static BytesRef` | BytesRef.`deepCopyOf(BytesRef other)` Creates a new BytesRef that points to a copy of the bytes from `other`
`BytesRef` | BytesRefHash.`get(int ord, BytesRef ref)` Populates and returns a `BytesRef` with the bytes for the given ord.
`BytesRef` | BytesRefIterator.`next()` Increments the iteration to the next `BytesRef` in the iterator.

Methods in org.apache.lucene.util that return types with arguments of type BytesRef
Modifier and Type | Method and Description
--- | ---
`Comparator<BytesRef>` | BytesRefIterator.`getComparator()` Return the `BytesRef` Comparator used to sort terms provided by the iterator.
`static Comparator<BytesRef>` | BytesRef.`getUTF8SortedAsUnicodeComparator()`
`static Comparator<BytesRef>` | BytesRef.`getUTF8SortedAsUTF16Comparator()` Deprecated. This comparator is only a transition mechanism

Methods in org.apache.lucene.util with parameters of type BytesRef
Modifier and Type | Method and Description
--- | ---
`int` | BytesRefHash.`add(BytesRef bytes)` Adds a new `BytesRef`
`int` | BytesRefHash.`add(BytesRef bytes, int code)` Adds a new `BytesRef` with a pre-calculated hash code.
`void` | NumericUtils.LongRangeBuilder.`addRange(BytesRef minPrefixCoded, BytesRef maxPrefixCoded)` Overwrite this method, if you like to receive the already prefix encoded range bounds.
`void` | NumericUtils.IntRangeBuilder.`addRange(BytesRef minPrefixCoded, BytesRef maxPrefixCoded)` Overwrite this method, if you like to receive the already prefix encoded range bounds.
`void` | BytesRef.`append(BytesRef other)` Appends the bytes from the given `BytesRef`
`void` | ByteBlockPool.`append(BytesRef bytes)` Appends the bytes in the provided `BytesRef` at the current position.
`static int` | StringHelper.`bytesDifference(BytesRef left, BytesRef right)` Compares two `BytesRef`, element by element, and returns the number of elements common to both arrays.
`boolean` | BytesRef.`bytesEquals(BytesRef other)` Expert: compares the bytes against another BytesRef, returning true if the bytes are equal.
`static int` | UnicodeUtil.`codePointCount(BytesRef utf8)` Returns the number of code points in this utf8 sequence.
`int` | BytesRef.`compareTo(BytesRef other)` Unsigned byte order comparison
`void` | PagedBytes.`copy(BytesRef bytes, BytesRef out)` Copy BytesRef in, setting BytesRef out to the result.
`void` | BytesRef.`copyBytes(BytesRef other)` Copies the bytes from the given `BytesRef`
`long` | PagedBytes.`copyUsingLengthPrefix(BytesRef bytes)` Copy bytes in, writing the length as a 1 or 2 byte vInt prefix.
`static BytesRef` | BytesRef.`deepCopyOf(BytesRef other)` Creates a new BytesRef that points to a copy of the bytes from `other`
`static boolean` | StringHelper.`endsWith(BytesRef ref, BytesRef suffix)` Returns `true` iff the ref ends with the given suffix.
`void` | PagedBytes.Reader.`fill(BytesRef b, long start)` Reads length as 1 or 2 byte vInt prefix, starting at start.
`void` | PagedBytes.Reader.`fillSlice(BytesRef b, long start, int length)` Gets a slice out of `PagedBytes` starting at start with a given length.
`BytesRef` | BytesRefHash.`get(int ord, BytesRef ref)` Populates and returns a `BytesRef` with the bytes for the given ord.
`static int` | NumericUtils.`getPrefixCodedIntShift(BytesRef val)` Returns the shift value from a prefix encoded `int`.
`static int` | NumericUtils.`getPrefixCodedLongShift(BytesRef val)` Returns the shift value from a prefix encoded `long`.
`static int` | NumericUtils.`intToPrefixCoded(int val, int shift, BytesRef bytes)` Returns prefix coded bits after reducing the precision by `shift` bits.
`static void` | NumericUtils.`intToPrefixCodedBytes(int val, int shift, BytesRef bytes)` Returns prefix coded bits after reducing the precision by `shift` bits.
`static int` | NumericUtils.`longToPrefixCoded(long val, int shift, BytesRef bytes)` Returns prefix coded bits after reducing the precision by `shift` bits.
`static void` | NumericUtils.`longToPrefixCodedBytes(long val, int shift, BytesRef bytes)` Returns prefix coded bits after reducing the precision by `shift` bits.
`static int` | NumericUtils.`prefixCodedToInt(BytesRef val)` Returns an int from prefixCoded bytes.
`static long` | NumericUtils.`prefixCodedToLong(BytesRef val)` Returns a long from prefixCoded bytes.
`void` | ByteBlockPool.`setBytesRef(BytesRef term, int textStart)`
`static boolean` | StringHelper.`startsWith(BytesRef ref, BytesRef prefix)` Returns `true` iff the ref starts with the given prefix.
`static void` | UnicodeUtil.`UTF16toUTF8(char[] source, int offset, int length, BytesRef result)` Encode characters from a char[] source, starting at offset for length chars.
`static void` | UnicodeUtil.`UTF16toUTF8(CharSequence s, int offset, int length, BytesRef result)` Encode characters from this String, starting at offset for length characters.
`static int` | UnicodeUtil.`UTF16toUTF8WithHash(char[] source, int offset, int length, BytesRef result)` Encode characters from a char[] source, starting at offset for length chars.
`static void` | UnicodeUtil.`UTF8toUTF16(BytesRef bytesRef, CharsRef chars)` Utility method for `UnicodeUtil.UTF8toUTF16(byte[], int, int, CharsRef)`
`static void` | UnicodeUtil.`UTF8toUTF32(BytesRef utf8, IntsRef utf32)`

Method parameters in org.apache.lucene.util with type arguments of type BytesRef
Modifier and Type | Method and Description
--- | ---
`int[]` | BytesRefHash.`sort(Comparator<BytesRef> comp)` Returns the values array sorted by the referenced byte values.

### Uses of BytesRef in org.apache.lucene.util.automaton

Fields in org.apache.lucene.util.automaton declared as BytesRef
Modifier and Type | Field and Description
--- | ---
`BytesRef` | CompiledAutomaton.`commonSuffixRef` Shared common suffix accepted by the automaton.
`BytesRef` | CompiledAutomaton.`term` For `CompiledAutomaton.AUTOMATON_TYPE.PREFIX`, this is the prefix term; for `CompiledAutomaton.AUTOMATON_TYPE.SINGLE` this is the singleton term.

Methods in org.apache.lucene.util.automaton that return BytesRef
Modifier and Type | Method and Description
--- | ---
`BytesRef` | CompiledAutomaton.`floor(BytesRef input, BytesRef output)` Finds largest term accepted by this Automaton, that's <= the provided input term.
`static BytesRef` | SpecialOperations.`getCommonPrefixBytesRef(Automaton a)`
`static BytesRef` | SpecialOperations.`getCommonSuffixBytesRef(Automaton a)`

Methods in org.apache.lucene.util.automaton with parameters of type BytesRef
Modifier and Type | Method and Description
--- | ---
`BytesRef` | CompiledAutomaton.`floor(BytesRef input, BytesRef output)` Finds largest term accepted by this Automaton, that's <= the provided input term.

Method parameters in org.apache.lucene.util.automaton with type arguments of type BytesRef
Modifier and Type | Method and Description
--- | ---
`static Automaton` | BasicAutomata.`makeStringUnion(Collection<BytesRef> utf8Strings)` Returns a new (deterministic and minimal) automaton that accepts the union of the given collection of `BytesRef`s representing UTF-8 encoded strings.

### Uses of BytesRef in org.apache.lucene.util.fst

Fields in org.apache.lucene.util.fst declared as BytesRef
Modifier and Type | Field and Description
--- | ---
`BytesRef` | BytesRefFSTEnum.InputOutput.`input`

Methods in org.apache.lucene.util.fst that return BytesRef
Modifier and Type | Method and Description
--- | ---
`BytesRef` | ByteSequenceOutputs.`add(BytesRef prefix, BytesRef output)`
`BytesRef` | ByteSequenceOutputs.`common(BytesRef output1, BytesRef output2)`
`BytesRef` | ByteSequenceOutputs.`getNoOutput()`
`BytesRef` | ByteSequenceOutputs.`read(DataInput in)`
`BytesRef` | ByteSequenceOutputs.`subtract(BytesRef output, BytesRef inc)`
`static BytesRef` | Util.`toBytesRef(IntsRef input, BytesRef scratch)` Just converts IntsRef to BytesRef; you must ensure the int values fit into a byte.

Methods in org.apache.lucene.util.fst with parameters of type BytesRef
Modifier and Type | Method and Description
--- | ---
`BytesRef` | ByteSequenceOutputs.`add(BytesRef prefix, BytesRef output)`
`BytesRef` | ByteSequenceOutputs.`common(BytesRef output1, BytesRef output2)`
`static <T> T` | Util.`get(FST<T> fst, BytesRef input)` Looks up the output for this input, or null if the input is not accepted
`String` | ByteSequenceOutputs.`outputToString(BytesRef output)`
`BytesRefFSTEnum.InputOutput<T>` | BytesRefFSTEnum.`seekCeil(BytesRef target)` Seeks to smallest term that's >= target.
`BytesRefFSTEnum.InputOutput<T>` | BytesRefFSTEnum.`seekExact(BytesRef target)` Seeks to exactly this term, returning null if the term doesn't exist.
`BytesRefFSTEnum.InputOutput<T>` | BytesRefFSTEnum.`seekFloor(BytesRef target)` Seeks to biggest term that's <= target.
`BytesRef` | ByteSequenceOutputs.`subtract(BytesRef output, BytesRef inc)`
`static BytesRef` | Util.`toBytesRef(IntsRef input, BytesRef scratch)` Just converts IntsRef to BytesRef; you must ensure the int values fit into a byte.
`static IntsRef` | Util.`toIntsRef(BytesRef input, IntsRef scratch)` Just takes unsigned byte values from the BytesRef and converts into an IntsRef.
`void` | ByteSequenceOutputs.`write(BytesRef prefix, DataOutput out)`

### Uses of BytesRef in org.apache.lucene.util.mutable

Fields in org.apache.lucene.util.mutable declared as BytesRef
Modifier and Type | Field and Description
--- | ---
`BytesRef` | MutableValueStr.`value`