Package org.apache.lucene.util
Class BytesRefArray
- java.lang.Object
-
- org.apache.lucene.util.BytesRefArray
-
- All Implemented Interfaces:
SortableBytesRefArray
public final class BytesRefArray extends java.lang.Object implements SortableBytesRefArray
A simple append only random-accessBytesRef
array that stores full copies of the appended bytes in aByteBlockPool
.Note: This class is not Thread-Safe!
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
BytesRefArray.IndexedBytesRefIterator
An extension ofBytesRefIterator
that allows retrieving the index of the current elementstatic class
BytesRefArray.SortState
Used to iterate the elements of an array in a given order.
-
Field Summary
Fields Modifier and Type Field Description private Counter
bytesUsed
private int
currentOffset
private int
lastElement
private int[]
offsets
private ByteBlockPool
pool
-
Constructor Summary
Constructors Constructor Description BytesRefArray(Counter bytesUsed)
Creates a newBytesRefArray
with a counter to track allocated bytes
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
append(BytesRef bytes)
Appends a copy of the givenBytesRef
to thisBytesRefArray
.void
clear()
Clears thisBytesRefArray
BytesRef
get(BytesRefBuilder spare, int index)
Returns the n'th element of thisBytesRefArray
BytesRefIterator
iterator()
sugar foriterator(Comparator)
with anull
comparatorBytesRefIterator
iterator(java.util.Comparator<BytesRef> comp)
Returns aBytesRefIterator
with point in time semantics.BytesRefArray.IndexedBytesRefIterator
iterator(BytesRefArray.SortState sortState)
Returns anBytesRefArray.IndexedBytesRefIterator
with point in time semantics.private void
setBytesRef(BytesRefBuilder spare, BytesRef result, int index)
Used only by sort below, to set aBytesRef
with the specified slice, avoiding copying bytes in the common case when the slice is contained in a single block in the byte block pool.int
size()
Returns the current size of thisBytesRefArray
BytesRefArray.SortState
sort(java.util.Comparator<BytesRef> comp, java.util.function.IntBinaryOperator tieComparator)
Returns aBytesRefArray.SortState
representing the order of elements in this array.
-
-
-
Field Detail
-
pool
private final ByteBlockPool pool
-
offsets
private int[] offsets
-
lastElement
private int lastElement
-
currentOffset
private int currentOffset
-
bytesUsed
private final Counter bytesUsed
-
-
Constructor Detail
-
BytesRefArray
public BytesRefArray(Counter bytesUsed)
Creates a newBytesRefArray
with a counter to track allocated bytes
-
-
Method Detail
-
clear
public void clear()
Clears thisBytesRefArray
- Specified by:
clear
in interfaceSortableBytesRefArray
-
append
public int append(BytesRef bytes)
Appends a copy of the givenBytesRef
to thisBytesRefArray
.- Specified by:
append
in interfaceSortableBytesRefArray
- Parameters:
bytes
- the bytes to append- Returns:
- the index of the appended bytes
-
size
public int size()
Returns the current size of thisBytesRefArray
- Specified by:
size
in interfaceSortableBytesRefArray
- Returns:
- the current size of this
BytesRefArray
-
get
public BytesRef get(BytesRefBuilder spare, int index)
Returns the n'th element of thisBytesRefArray
- Parameters:
spare
- a spareBytesRef
instanceindex
- the elements index to retrieve- Returns:
- the n'th element of this
BytesRefArray
-
setBytesRef
private void setBytesRef(BytesRefBuilder spare, BytesRef result, int index)
Used only by sort below, to set aBytesRef
with the specified slice, avoiding copying bytes in the common case when the slice is contained in a single block in the byte block pool.
-
sort
public BytesRefArray.SortState sort(java.util.Comparator<BytesRef> comp, java.util.function.IntBinaryOperator tieComparator)
Returns aBytesRefArray.SortState
representing the order of elements in this array. This is a non-destructive operation.
-
iterator
public BytesRefIterator iterator()
sugar foriterator(Comparator)
with anull
comparator
-
iterator
public BytesRefIterator iterator(java.util.Comparator<BytesRef> comp)
Returns aBytesRefIterator
with point in time semantics. The iterator provides access to all so far appendedBytesRef
instances.If a non
null
Comparator
is provided the iterator will iterate the byte values in the order specified by the comparator. Otherwise the order is the same as the values were appended.This is a non-destructive operation.
- Specified by:
iterator
in interfaceSortableBytesRefArray
-
iterator
public BytesRefArray.IndexedBytesRefIterator iterator(BytesRefArray.SortState sortState)
Returns anBytesRefArray.IndexedBytesRefIterator
with point in time semantics. The iterator provides access to all so far appendedBytesRef
instances. If a non-null sortState is specified then the iterator will iterate the byte values in the order of the sortState; otherwise, the order is the same as the values were appended.
-
-