com.latencybusters.lbm
Class UMQIndexInfo

java.lang.Object
  com.latencybusters.lbm.UMQIndexInfo

public class UMQIndexInfo
extends java.lang.Object

Constructor Summary

UMQIndexInfo()

UMQIndexInfo(byte[] index, int length)
Creates a UMQIndexInfo object and initializes fields to the supplied values.

UMQIndexInfo(long index)
Creates a numeric UMQIndexInfo object and initializes fields to the supplied values.

Method Summary

int	flags() Returns flags for the UMQIndexInfo object.
byte[]	index() Returns index for non-numeric UMQIndexInfo objects.
int	indexLength() Returns length of non-numeric index.
long	numericIndex() Returns numeric index for numeric UMQIndexInfo objects.
void	setIndex(byte[] index, int length) Sets non-numeric index to given data.
void	setNumericIndex(long index) Sets the numeric index value of a numeric UMQIndexInfo object.

Methods inherited from class java.lang.Object

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

Constructor Detail

UMQIndexInfo

public UMQIndexInfo(byte[] index,
                    int length)
             throws LBMEInvalException

Creates a UMQIndexInfo object and initializes fields to the supplied values.

Parameters:

index - Index (user-specified binary data).

length - Length of index data.

Throws:

LBMEInvalException - An invalid parameter was specified.

Since:

UMQ 1.2

UMQIndexInfo

public UMQIndexInfo(long index)

Creates a numeric UMQIndexInfo object and initializes fields to the supplied values.

Parameters:

index - Numeric index (64-bit number).

Throws:

LBMEInvalException - An invalid parameter was specified.

Since:

UMQ 1.2

UMQIndexInfo

public UMQIndexInfo()

Method Detail

flags

public int flags()

Returns flags for the UMQIndexInfo object.

Returns:

flags.

Since:

UMQ 1.2

index

public byte[] index()
             throws LBMEInvalException

Returns index for non-numeric UMQIndexInfo objects.

Returns:

Index data.

Throws:

LBMEInvalException - if the index is numeric.

Since:

UMQ 1.2

numericIndex

public long numericIndex()
                  throws LBMEInvalException

Returns numeric index for numeric UMQIndexInfo objects.

Returns:

Numeric index.

Throws:

LBMEInvalException - if the index is not numeric.

Since:

UMQ 1.2

indexLength

public int indexLength()
                throws LBMEInvalException

Returns length of non-numeric index.

Returns:

Index length.

Throws:

LBMEInvalException - if called on a numeric UMQIndexInfo object.

Since:

UMQ 1.2

setIndex

public void setIndex(byte[] index,
                     int length)
              throws LBMEInvalException

Sets non-numeric index to given data.

Parameters:

index - Index data to set.

length - Length of index data.

Throws:

LBMEInvalException - if index data is null, or index length is <= 0 or > LBM.UMQ_MAX_INDEX_LEN.

Since:

UMQ 1.2

setNumericIndex

public void setNumericIndex(long index)

Sets the numeric index value of a numeric UMQIndexInfo object.

Parameters:

index - The numeric index to set.

Since:

UMQ 1.2