org.apache.lucene.util

Class IntsRef

java.lang.Object

org.apache.lucene.util.IntsRef

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<IntsRef>

public final class IntsRef
extends java.lang.Object
implements java.lang.Comparable<IntsRef>, java.lang.Cloneable

Represents int[], as a slice (offset + length) into an existing int[].

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

Field Summary

Fields

Modifier and Type	Field and Description
static int[]	EMPTY_INTS
int[]	ints
int	length
int	offset

Constructor Summary

Constructors

Constructor and Description
IntsRef()
IntsRef(int capacity)
IntsRef(int[] ints, int offset, int length)

Method Summary

Modifier and Type	Method and Description
IntsRef	clone()
int	compareTo(IntsRef other) Signed int order comparison
void	copyInts(IntsRef other)
static IntsRef	deepCopyOf(IntsRef other) Creates a new IntsRef that points to a copy of the ints from other
boolean	equals(java.lang.Object other)
void	grow(int newLength) Used to grow the reference array.
int	hashCode()
boolean	intsEquals(IntsRef other)
java.lang.String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_INTS

public static final int[] EMPTY_INTS

ints

public int[] ints

offset

public int offset

length

public int length

Constructor Detail

IntsRef

public IntsRef()

IntsRef

public IntsRef(int capacity)

IntsRef

public IntsRef(int[] ints,
               int offset,
               int length)

Method Detail

clone

public IntsRef clone()

Overrides:

clone in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

intsEquals

public boolean intsEquals(IntsRef other)

compareTo

public int compareTo(IntsRef other)

Signed int order comparison

Specified by:

compareTo in interface java.lang.Comparable<IntsRef>

copyInts

public void copyInts(IntsRef other)

grow

public void grow(int newLength)

Used to grow the reference array. In general this should not be used as it does not take the offset into account.

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

deepCopyOf

public static IntsRef deepCopyOf(IntsRef other)

Creates a new IntsRef that points to a copy of the ints from other

The returned IntsRef will have a length of other.length and an offset of zero.