votorola.g.util

Class IndexOffsetter

java.lang.Object

IndexOffsetter

All Implemented Interfaces:

Serializable

@ThreadRestricted(value="touch")
public final class IndexOffsetter
extends Object
implements Serializable

Index offsetter for a sequence of fixed size. It implements a logical index whose start (logical zero) may be offset from actual zero, and whose increments will wrap around the end of sequence.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IndexOffsetter(int s) Constructs an IndexOffsetter.

Method Summary

Methods

Modifier and Type	Method and Description
int	actualIndex(int logicalIndex) Returns the actual index of a given logical index.
void	setActualIndexOfLogicalZero(int actualIndex) Sets the actual index of logical index zero.
int	size() Returns the size of the sequence.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexOffsetter

public IndexOffsetter(int s)

Constructs an IndexOffsetter.

Parameters:

s - size per size()

Method Detail

actualIndex

public int actualIndex(int logicalIndex)

Returns the actual index of a given logical index.

Parameters:

logicalIndex - logical index in sequence (positive or negative)

Returns:

actual index, wrapped as necessary around the end of the sequence

Throws:

ArrayIndexOutOfBoundsException - if |logicalIndex| >= size()

setActualIndexOfLogicalZero

@ThreadRestricted
public void setActualIndexOfLogicalZero(int actualIndex)

Sets the actual index of logical index zero. When this is zero (the default), the logical index is identical to the actual index.

Throws:

ArrayIndexOutOfBoundsException - if actualIndex < 0 or actualIndex >= size()

size

public int size()

Returns the size of the sequence.