com.grey.base.utils

Class ArrayRef<T>

java.lang.Object

com.grey.base.utils.ArrayRef<T>

Direct Known Subclasses:

ByteArrayRef, CharBlock, NumberList, ObjectArrayRef

public class ArrayRef<T>
extends Object

Handy array handle. Allows us to specify all or part of an array buffer without having to pass around the 3 separate parameters that describe it (buffer, offset, length).
Note that Java generics don't take primitive types like byte and char, so instances of this class have to be declared with T as byte[], char[], Object[] etc. It does not make sense for T to be anything other than an array.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ArrayRef.Allocator<T>

Constructor Summary

Constructors

Constructor and Description
ArrayRef()
ArrayRef(ArrayRef<T> src)
ArrayRef(ArrayRef<T> src, ArrayRef.Allocator<T> allocator)
ArrayRef(ArrayRef<T> src, int off, int len)
ArrayRef(ArrayRef<T> src, int off, int len, ArrayRef.Allocator<T> allocator)
ArrayRef(int capacity, ArrayRef.Allocator<T> allocator)
ArrayRef(T src, int off, int len)
ArrayRef(T src, int off, int len, ArrayRef.Allocator<T> allocator)

Method Summary

Modifier and Type	Method and Description
void	advance(int incr)
protected T	allocBuffer(int capacity)
T	buffer()
boolean	canEqual(Object obj)
protected int	capacity()
ArrayRef<T>	clear()
static <T> void	copy(ArrayRef<T> src, int src_off, ArrayRef<T> dst, int dst_off, int len)
void	copyIn(T src_buf, int src_off, int len)
void	copyIn(T src_buf, int src_off, int off, int len)
void	copyOut(int off, T dst_buf, int dst_off, int len)
void	copyOut(T dst_buf, int dst_off)
ArrayRef<T>	ensureCapacity(int capacity)
ArrayRef<T>	ensureSpareCapacity(int spareCapacity)
boolean	equals(Object obj) Note that since this class is basically a glorified pointer, the Equals method merely checks that they both point to the same memory location.
protected static <T> T	getBuffer(ArrayRef<T> ref)
protected static <T> int	getOffset(ArrayRef<T> ref)
protected static <T> int	getOffset(ArrayRef<T> ref, int off)
protected static <T> int	getSize(ArrayRef<T> ref)
int	hashCode()
void	incrementSize(int len)
int	limit()
int	offset()
int	offset(int off)
ArrayRef<T>	set(ArrayRef<T> src)
ArrayRef<T>	set(ArrayRef<T> src, int off)
ArrayRef<T>	set(ArrayRef<T> src, int off, int len)
ArrayRef<T>	set(T src)
ArrayRef<T>	set(T buf, int off, int len)
void	setSize(int len)
int	size()
protected int	spareCapacity()
T	toArray()
T	toArray(boolean nocopy)
T	toArray(int off, int len)
T	toArray(int off, int len, boolean nocopy)
String	toString()
protected int	totalBufferSize()
protected int	totalBufferSize(T buf)

Methods inherited from class java.lang.Object

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

Constructor Detail

ArrayRef

public ArrayRef()

ArrayRef

public ArrayRef(T src,
                int off,
                int len)

ArrayRef

public ArrayRef(ArrayRef<T> src)

ArrayRef

public ArrayRef(ArrayRef<T> src,
                ArrayRef.Allocator<T> allocator)

ArrayRef

public ArrayRef(ArrayRef<T> src,
                int off,
                int len)

ArrayRef

public ArrayRef(ArrayRef<T> src,
                int off,
                int len,
                ArrayRef.Allocator<T> allocator)

ArrayRef

public ArrayRef(T src,
                int off,
                int len,
                ArrayRef.Allocator<T> allocator)

ArrayRef

public ArrayRef(int capacity,
                ArrayRef.Allocator<T> allocator)

Method Detail

set

public ArrayRef<T> set(T src)

set

public ArrayRef<T> set(ArrayRef<T> src)

set

public ArrayRef<T> set(ArrayRef<T> src,
                       int off)

set

public ArrayRef<T> set(ArrayRef<T> src,
                       int off,
                       int len)

size

public final int size()

offset

public final int offset()

buffer

public final T buffer()

setSize

public final void setSize(int len)

offset

public final int offset(int off)

limit

public final int limit()

capacity

protected final int capacity()

spareCapacity

protected final int spareCapacity()

incrementSize

public final void incrementSize(int len)

clear

public ArrayRef<T> clear()

toArray

public T toArray()

toArray

public T toArray(boolean nocopy)

toArray

public T toArray(int off,
                 int len)

totalBufferSize

protected int totalBufferSize()

totalBufferSize

protected int totalBufferSize(T buf)

allocBuffer

protected T allocBuffer(int capacity)

set

public ArrayRef<T> set(T buf,
                       int off,
                       int len)

copyIn

public void copyIn(T src_buf,
                   int src_off,
                   int off,
                   int len)

copyIn

public void copyIn(T src_buf,
                   int src_off,
                   int len)

copyOut

public void copyOut(int off,
                    T dst_buf,
                    int dst_off,
                    int len)

copyOut

public void copyOut(T dst_buf,
                    int dst_off)

copy

public static <T> void copy(ArrayRef<T> src,
                            int src_off,
                            ArrayRef<T> dst,
                            int dst_off,
                            int len)

ensureCapacity

public ArrayRef<T> ensureCapacity(int capacity)

ensureSpareCapacity

public ArrayRef<T> ensureSpareCapacity(int spareCapacity)

toArray

public T toArray(int off,
                 int len,
                 boolean nocopy)

equals

public boolean equals(Object obj)

Note that since this class is basically a glorified pointer, the Equals method merely checks that they both point to the same memory location.
The fact that two ArrayRef objects point at different buffers does not mean that the pointed-to contents are unequal in terms of their own array-class semantics, but they are unequal from the point of view of this class, so if you are interested in that sort of equality, this method is not relevant.
Subclasses of ArrayRef must override this method, if they are in a position to know what their array type is and expect equals() to take the buffer contents into account.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

canEqual

public boolean canEqual(Object obj)

toString

public String toString()

Overrides:

toString in class Object

advance

public void advance(int incr)

getBuffer

protected static <T> T getBuffer(ArrayRef<T> ref)

getSize

protected static <T> int getSize(ArrayRef<T> ref)

getOffset

protected static <T> int getOffset(ArrayRef<T> ref)

getOffset

protected static <T> int getOffset(ArrayRef<T> ref,
                                   int off)