Package org.apache.lucene.util
Class BytesRefArray
- java.lang.Object
-
- org.apache.lucene.util.BytesRefArray
-
public final class BytesRefArray extends Object
A simple append only random-accessBytesRefarray that stores full copies of the appended bytes in aByteBlockPool.Note: This class is not Thread-Safe!
- WARNING: This API is experimental and might change in incompatible ways in the next release.
- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceBytesRefArray.IndexedBytesRefIteratorAn extension ofBytesRefIteratorthat allows retrieving the index of the current elementstatic classBytesRefArray.SortStateUsed to iterate the elements of an array in a given order.
-
Constructor Summary
Constructors Constructor Description BytesRefArray(Counter bytesUsed)Creates a newBytesRefArraywith a counter to track allocated bytes
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intappend(BytesRef bytes)Appends a copy of the givenBytesRefto thisBytesRefArray.voidclear()Clears thisBytesRefArrayBytesRefget(BytesRefBuilder spare, int index)Returns the n'th element of thisBytesRefArrayBytesRefIteratoriterator()sugar foriterator(Comparator)with anullcomparatorBytesRefIteratoriterator(Comparator<BytesRef> comp)Returns aBytesRefIteratorwith point in time semantics.BytesRefArray.IndexedBytesRefIteratoriterator(BytesRefArray.SortState sortState)Returns anBytesRefArray.IndexedBytesRefIteratorwith point in time semantics.intsize()Returns the current size of thisBytesRefArrayBytesRefArray.SortStatesort(Comparator<BytesRef> comp, boolean stable)Returns aBytesRefArray.SortStaterepresenting the order of elements in this array.
-
-
-
Constructor Detail
-
BytesRefArray
public BytesRefArray(Counter bytesUsed)
Creates a newBytesRefArraywith a counter to track allocated bytes
-
-
Method Detail
-
clear
public void clear()
Clears thisBytesRefArray
-
append
public int append(BytesRef bytes)
Appends a copy of the givenBytesRefto thisBytesRefArray.- Parameters:
bytes- the bytes to append- Returns:
- the index of the appended bytes
-
size
public int size()
Returns the current size of thisBytesRefArray- 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 spareBytesRefinstanceindex- the elements index to retrieve- Returns:
- the n'th element of this
BytesRefArray
-
sort
public BytesRefArray.SortState sort(Comparator<BytesRef> comp, boolean stable)
Returns aBytesRefArray.SortStaterepresenting the order of elements in this array. This is a non-destructive operation.- Parameters:
comp- The comparator to compareBytesRefs. A radix sort optimization is available if the comparator implementsBytesRefComparatorstable- If the sort needs to be stable- Returns:
- A
BytesRefArray.SortStatethat could be used initerator(SortState)
-
iterator
public BytesRefIterator iterator()
sugar foriterator(Comparator)with anullcomparator
-
iterator
public BytesRefIterator iterator(Comparator<BytesRef> comp)
Returns aBytesRefIteratorwith point in time semantics. The iterator provides access to all so far appendedBytesRefinstances.If a non
nullComparatoris 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.
-
iterator
public BytesRefArray.IndexedBytesRefIterator iterator(BytesRefArray.SortState sortState)
Returns anBytesRefArray.IndexedBytesRefIteratorwith point in time semantics. The iterator provides access to all so far appendedBytesRefinstances. 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.
-
-