Package org.apache.lucene.util
Class IntsRef
- java.lang.Object
-
- org.apache.lucene.util.IntsRef
-
- All Implemented Interfaces:
Cloneable,Comparable<IntsRef>
public final class IntsRef extends Object implements Comparable<IntsRef>, Cloneable
Represents int[], as a slice (offset + length) into an existing int[]. Theintsmember should never be null; useEMPTY_INTSif necessary.- 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 Description static int[]EMPTY_INTSAn empty integer array for convenienceint[]intsThe contents of the IntsRef.intlengthLength of used ints.intoffsetOffset of first valid integer.
-
Constructor Summary
Constructors Constructor Description IntsRef()Create a IntsRef withEMPTY_INTSIntsRef(int capacity)Create a IntsRef pointing to a new array of sizecapacity.IntsRef(int[] ints, int offset, int length)This instance will directly reference ints w/o making a copy.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description IntsRefclone()Returns a shallow clone of this instance (the underlying ints are not copied and will be shared by both the returned object and this object.intcompareTo(IntsRef other)Signed int order comparisonstatic IntsRefdeepCopyOf(IntsRef other)Creates a new IntsRef that points to a copy of the ints fromotherbooleanequals(Object other)inthashCode()booleanintsEquals(IntsRef other)booleanisValid()Performs internal consistency checks.StringtoString()
-
-
-
Constructor Detail
-
IntsRef
public IntsRef()
Create a IntsRef withEMPTY_INTS
-
IntsRef
public IntsRef(int capacity)
Create a IntsRef pointing to a new array of sizecapacity. Offset and length will both be zero.
-
IntsRef
public IntsRef(int[] ints, int offset, int length)This instance will directly reference ints w/o making a copy. ints should not be null.
-
-
Method Detail
-
clone
public IntsRef clone()
Returns a shallow clone of this instance (the underlying ints are not copied and will be shared by both the returned object and this object.- Overrides:
clonein classObject- See Also:
deepCopyOf(org.apache.lucene.util.IntsRef)
-
intsEquals
public boolean intsEquals(IntsRef other)
-
compareTo
public int compareTo(IntsRef other)
Signed int order comparison- Specified by:
compareToin interfaceComparable<IntsRef>
-
deepCopyOf
public static IntsRef deepCopyOf(IntsRef other)
Creates a new IntsRef that points to a copy of the ints fromotherThe returned IntsRef will have a length of other.length and an offset of zero.
-
isValid
public boolean isValid()
Performs internal consistency checks. Always returns true (or throws IllegalStateException)
-
-