edu.ksu.cis.projects.bogor.module.value
Interface IArrayValue

All Superinterfaces:

Comparable<IValue>, Disposable, INonPrimitiveValue, IRecordValue, IValue, Serializable

All Known Implementing Classes:

DefaultArrayValue

public interface IArrayValue
extends IRecordValue

Represents an array value.

Version:

CVS $Revision: 1.3 $ $Date: 2005/06/06 19:15:31 $

Author:

Robby

Method Summary

IArrayValue	clone(Map<Object,Object> cloneMap) Override to specialize return type.
IValue	getElementValue(int elementIndex) Gets an array element's value.
IValueArray	getElementValues() Gets the element values.
int	getLength() Gets the length of this array.
void	setElementValue(int elementIndex, IValue elementValue) Sets an array element's value.
String	toVerboseString() Returns the verbose string representation of this array.

Methods inherited from interface edu.ksu.cis.projects.bogor.module.value.IRecordValue

getFieldCount, getFieldValue, getFieldValues, getLockValue, linearize, setFieldValue

Methods inherited from interface edu.ksu.cis.projects.bogor.module.value.INonPrimitiveValue

getReferenceId

Methods inherited from interface edu.ksu.cis.projects.bogor.module.value.IValue

equals, getType, getTypeId, hashCode, toString, validate

Methods inherited from interface edu.ksu.cis.projects.bogor.util.Disposable

dispose

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

setElementValue

void setElementValue(int elementIndex,
                     IValue elementValue)

Sets an array element's value.

Parameters:

elementIndex - The index of the element in this array. Must be greater than zero and less than the length of this array.

elementValue - The new value of the element. Must be non-null.

getElementValue

IValue getElementValue(int elementIndex)

Gets an array element's value.

Parameters:

elementIndex - The index of the element in this array. Must be greater than zero and less than the length of this array.

Returns:

The element's value. Non-null.

getElementValues

IValueArray getElementValues()

Gets the element values.

Returns:

The element values. Non-null.

getLength

int getLength()

Gets the length of this array.

Returns:

The length of this array. At least zero.

toVerboseString

String toVerboseString()

Returns the verbose string representation of this array.

Specified by:

toVerboseString in interface IRecordValue

Returns:

The verbose string representation of this array. Non-null. The string contains the string representations of this array's elements and fields.

clone

IArrayValue clone(Map<Object,Object> cloneMap)

Override to specialize return type.

Specified by:

clone in interface INonPrimitiveValue

Specified by:

clone in interface IRecordValue

Specified by:

clone in interface IValue

Parameters:

cloneMap - Original values (IValue) to their clones ( IValue) mapping. The clone map to solve circular references in values. If this value is a key in the map, then this method returns the value of the key in the map. Must be non-null.

Returns:

The clone of this value. Non-null.