Skip to content

Commit

Permalink
Add @lucene.internal
Browse files Browse the repository at this point in the history
  • Loading branch information
bruno-roustant committed May 27, 2024
1 parent 63bb1c0 commit 7e42487
Show file tree
Hide file tree
Showing 24 changed files with 74 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
* Simplifies the implementation of iterators a bit. Modeled loosely after Google Guava's API.
*
* <p>Forked from com.carrotsearch.hppc.AbstractIterator
*
* @lucene.internal
*/
public abstract class AbstractIterator<E> implements Iterator<E> {
private static final int NOT_CACHED = 0;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
* <p>Forked from com.carrotsearch.hppc.BitMixer
*
* <p>github: https://github.com/carrotsearch/hppc release: 0.10.0
*
* @lucene.internal
*/
public final class BitMixer {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,11 @@
import java.util.IllegalFormatException;
import java.util.Locale;

/** BufferAllocationException forked from HPPC */
/**
* BufferAllocationException forked from HPPC.
*
* @lucene.internal
*/
public class BufferAllocationException extends RuntimeException {
public BufferAllocationException(String message) {
super(message);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@

package org.apache.lucene.util.hppc;

/** Forked from HPPC, holding int index and char value */
/**
* Forked from HPPC, holding int index and char value.
*
* @lucene.internal
*/
public final class CharCursor {
/**
* The current value's index in the container this cursor belongs to. The meaning of this index is
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@
*
* <p>Mostly forked and trimmed from com.carrotsearch.hppc.CharHashSet
*
* <p>github: https://github.com/carrotsearch/hppc release 0.9.0
* <p>github: https://github.com/carrotsearch/hppc release 0.10.0
*
* @lucene.internal
*/
public class CharHashSet implements Iterable<CharCursor>, Accountable, Cloneable {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@
*
* <p>Mostly forked and trimmed from com.carrotsearch.hppc.CharObjectHashMap
*
* <p>github: https://github.com/carrotsearch/hppc release 0.9.0
* <p>github: https://github.com/carrotsearch/hppc release 0.10.0
*
* @lucene.internal
*/
@SuppressWarnings("unchecked")
public class CharObjectHashMap<VType>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@

package org.apache.lucene.util.hppc;

/** Forked from HPPC, holding int index and double value */
/**
* Forked from HPPC, holding int index and double value.
*
* @lucene.internal
*/
public final class DoubleCursor {
/**
* The current value's index in the container this cursor belongs to. The meaning of this index is
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
* <p>Mostly forked and trimmed from com.carrotsearch.hppc.FloatArrayList
*
* <p>github: https://github.com/carrotsearch/hppc release 0.10.0
*
* @lucene.internal
*/
public class FloatArrayList implements Iterable<FloatCursor>, Cloneable, Accountable {
private static final long BASE_RAM_BYTES_USED =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@

package org.apache.lucene.util.hppc;

/** Forked from HPPC, holding int index and float value */
/**
* Forked from HPPC, holding int index and float value.
*
* @lucene.internal
*/
public final class FloatCursor {
/**
* The current value's index in the container this cursor belongs to. The meaning of this index is
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,11 @@

import java.util.concurrent.atomic.AtomicInteger;

/** Constants for primitive maps. */
/**
* Constants for primitive maps.
*
* @lucene.internal
*/
class HashContainers {

static final int DEFAULT_EXPECTED_ELEMENTS = 4;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
* <p>Mostly forked and trimmed from com.carrotsearch.hppc.IntArrayList
*
* <p>github: https://github.com/carrotsearch/hppc release 0.10.0
*
* @lucene.internal
*/
public class IntArrayList implements Iterable<IntCursor>, Cloneable, Accountable {
private static final long BASE_RAM_BYTES_USED =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@

package org.apache.lucene.util.hppc;

/** Forked from HPPC, holding int index and int value */
/**
* Forked from HPPC, holding int index and int value.
*
* @lucene.internal
*/
public final class IntCursor {
/**
* The current value's index in the container this cursor belongs to. The meaning of this index is
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@
* <p>Mostly forked and trimmed from com.carrotsearch.hppc.IntDoubleHashMap
*
* <p>github: https://github.com/carrotsearch/hppc release 0.10.0
*
* @lucene.internal
*/
public class IntDoubleHashMap
implements Iterable<IntDoubleHashMap.IntDoubleCursor>, Accountable, Cloneable {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@
* <p>Mostly forked and trimmed from com.carrotsearch.hppc.IntFloatHashMap
*
* <p>github: https://github.com/carrotsearch/hppc release 0.10.0
*
* @lucene.internal
*/
public class IntFloatHashMap
implements Iterable<IntFloatHashMap.IntFloatCursor>, Accountable, Cloneable {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
* <p>Mostly forked and trimmed from com.carrotsearch.hppc.IntHashSet
*
* <p>github: https://github.com/carrotsearch/hppc release 0.10.0
*
* @lucene.internal
*/
public class IntHashSet implements Iterable<IntCursor>, Accountable, Cloneable {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
* <p>Mostly forked and trimmed from com.carrotsearch.hppc.IntIntHashMap
*
* <p>github: https://github.com/carrotsearch/hppc release 0.10.0
*
* @lucene.internal
*/
public class IntIntHashMap implements Iterable<IntIntHashMap.IntIntCursor>, Accountable, Cloneable {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
* <p>Mostly forked and trimmed from com.carrotsearch.hppc.IntObjectHashMap
*
* <p>github: https://github.com/carrotsearch/hppc release 0.10.0
*
* @lucene.internal
*/
@SuppressWarnings("unchecked")
public class IntObjectHashMap<VType>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
* <p>Mostly forked and trimmed from com.carrotsearch.hppc.LongArrayList
*
* <p>github: https://github.com/carrotsearch/hppc release 0.10.0
*
* @lucene.internal
*/
public class LongArrayList implements Iterable<LongCursor>, Cloneable, Accountable {
private static final long BASE_RAM_BYTES_USED =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@

package org.apache.lucene.util.hppc;

/** Forked from HPPC, holding int index and long value */
/**
* Forked from HPPC, holding int index and long value.
*
* @lucene.internal
*/
public final class LongCursor {
/**
* The current value's index in the container this cursor belongs to. The meaning of this index is
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@
* <p>Mostly forked and trimmed from com.carrotsearch.hppc.LongFloatHashMap
*
* <p>github: https://github.com/carrotsearch/hppc release 0.10.0
*
* @lucene.internal
*/
public class LongFloatHashMap
implements Iterable<LongFloatHashMap.LongFloatCursor>, Accountable, Cloneable {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
* <p>Mostly forked and trimmed from com.carrotsearch.hppc.LongHashSet
*
* <p>github: https://github.com/carrotsearch/hppc release 0.10.0
*
* @lucene.internal
*/
public class LongHashSet implements Iterable<LongCursor>, Accountable, Cloneable {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
* <p>Mostly forked and trimmed from com.carrotsearch.hppc.LongIntHashMap
*
* <p>github: https://github.com/carrotsearch/hppc release 0.10.0
*
* @lucene.internal
*/
public class LongIntHashMap
implements Iterable<LongIntHashMap.LongIntCursor>, Accountable, Cloneable {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
* <p>Mostly forked and trimmed from com.carrotsearch.hppc.LongObjectHashMap
*
* <p>github: https://github.com/carrotsearch/hppc release 0.10.0
*
* @lucene.internal
*/
@SuppressWarnings("unchecked")
public class LongObjectHashMap<VType>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@

package org.apache.lucene.util.hppc;

/** Forked from HPPC, holding int index and Object value */
/**
* Forked from HPPC, holding int index and Object value.
*
* @lucene.internal
*/
public final class ObjectCursor<VType> {
/**
* The current value's index in the container this cursor belongs to. The meaning of this index is
Expand Down

0 comments on commit 7e42487

Please sign in to comment.