com.denodo.common.custom.elements

Interface CustomArrayValue

public interface CustomArrayValue

This class represents an array in the Denodo Platform values structure. Each value of the array is a CustomRecordValue.

Since:

4.6

Method Summary

Modifier and Type	Method and Description
void	addValue(CustomRecordValue value) Appends the specified CustomRecordValue to the end of this array.
void	addValue(CustomRecordValue value, int position) Inserts the specified CustomRecordValue at the specified position in this array.
CustomRecordValue	getValue(int position) Returns the element at the specified position in this array.
List<CustomRecordValue>	getValues() Obtains all the values in the array.
CustomRecordValue	removeValue(int position) Removes the element at the specified position in this array.
int	size() Method to obtain the length of the array.

Method Detail

size

int size()

Method to obtain the length of the array.

Returns:

The number of values contained in the array.

getValue

CustomRecordValue getValue(int position)

Returns the element at the specified position in this array.

Parameters:

position - index of element to return.

Returns:

the element at the specified position in this array.

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

getValues

List<CustomRecordValue> getValues()

Obtains all the values in the array.

Returns:

A List of all the values in the array.

addValue

void addValue(CustomRecordValue value,
              int position)

Inserts the specified CustomRecordValue at the specified position in this array. Shifts the element currently at that position (if any) and any subsequent elements to the right.

Parameters:

position - index at which the specified element is to be inserted.

value - element to be inserted.

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size()).

addValue

void addValue(CustomRecordValue value)

Appends the specified CustomRecordValue to the end of this array.

Parameters:

value - element to be appended to this array.

removeValue

CustomRecordValue removeValue(int position)

Removes the element at the specified position in this array. Shifts any subsequent elements to the left . Returns the element that was removed from the array.

Parameters:

position - the index of the element to removed.

Returns:

the element previously at the specified position.

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).