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

Packages that use BytesRef
org.apache.lucene.util: Some utility classes.
org.apache.lucene.util.fst: Finite state transducers

Uses of BytesRef in org.apache.lucene.util

Methods in org.apache.lucene.util that return BytesRef
`BytesRef` `BytesRef.clone()`
`BytesRef` `ByteBlockPool.copyFrom(BytesRef bytes)`
`static BytesRef` `BytesRef.deepCopyOf(BytesRef other)` Creates a new BytesRef that points to a copy of the bytes from `other`
`BytesRef` `PagedBytes.Reader.fill(BytesRef b, long start)` Reads length as 1 or 2 byte vInt prefix, starting at start.
`BytesRef` `PagedBytes.Reader.fillSlice(BytesRef b, long start, int length)` Gets a slice out of `PagedBytes` starting at start with a given length.
`BytesRef` `PagedBytes.Reader.fillSliceWithPrefix(BytesRef b, long start)` Gets a slice out of `PagedBytes` starting at start, the length is read as 1 or 2 byte vInt prefix.
`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.
`BytesRef` `ByteBlockPool.setBytesRef(BytesRef term, int textStart)`

Methods in org.apache.lucene.util that return types with arguments of type BytesRef
`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()`

Methods in org.apache.lucene.util with parameters of type BytesRef
`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` `BytesRef.append(BytesRef other)` Appends the bytes from the given `BytesRef`
`boolean` `BytesRef.bytesEquals(BytesRef other)` Expert: compares the bytes against another BytesRef, returning true if the bytes are equal.
`int` `BytesRef.compareTo(BytesRef other)` Unsigned byte order comparison
`void` `PagedBytes.copy(BytesRef bytes)` Copy BytesRef in
`void` `ByteBlockPool.copy(BytesRef bytes)` Copies the given `BytesRef` at the current positions ( `ByteBlockPool.byteUpto` across buffer boundaries
`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`
`BytesRef` `ByteBlockPool.copyFrom(BytesRef bytes)`
`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`
`boolean` `BytesRef.endsWith(BytesRef other)`
`BytesRef` `PagedBytes.Reader.fill(BytesRef b, long start)` Reads length as 1 or 2 byte vInt prefix, starting at start.
`int` `PagedBytes.Reader.fillAndGetIndex(BytesRef b, long start)` Reads length as 1 or 2 byte vInt prefix, starting at start.
`long` `PagedBytes.Reader.fillAndGetStart(BytesRef b, long start)` Reads length as 1 or 2 byte vInt prefix, starting at start and returns the start offset of the next part, suitable as start parameter on next call to sequentially read all `BytesRef`.
`BytesRef` `PagedBytes.Reader.fillSlice(BytesRef b, long start, int length)` Gets a slice out of `PagedBytes` starting at start with a given length.
`BytesRef` `PagedBytes.Reader.fillSliceWithPrefix(BytesRef b, long start)` Gets a slice out of `PagedBytes` starting at start, the length is read as 1 or 2 byte vInt prefix.
`BytesRef` `BytesRefHash.get(int ord, BytesRef ref)` Populates and returns a `BytesRef` with the bytes for the given ord.
`BytesRef` `ByteBlockPool.setBytesRef(BytesRef term, int textStart)`
`boolean` `BytesRef.startsWith(BytesRef other)`
`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)`

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

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

Fields in org.apache.lucene.util.fst declared as BytesRef
`BytesRef` `BytesRefFSTEnum.InputOutput.input`

Methods in org.apache.lucene.util.fst that return BytesRef
`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
`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)`