Vehicle Properties  1.0.0-beta4
Vehicle Properties API
DataObjectIntegerArray Class Reference

The DataObjectIntegerArray class is used to model an Integer array as a Kanzi DataObjectList with a DataObjectInt as each element. More...

Inherits DataObjectList.

Public Member Functions

DataObject acquireItem (int index)
 Acquires an item from the list at the provided index. More...
 
void close ()
 Closes the DataObjectIntegerArray object.
 
ObjectRef< DataObjectInt > getItemTemplate ()
 Returns tree structure of the data source for individual list item. More...
 
Integer [] getValue ()
 Gets the value of the list as an Integer Array. More...
 
int itemCount ()
 Gets the count of items in the list. More...
 
void releaseItem (int index)
 Releases the memory resources associated with a particular item. More...
 
void setValue (Integer[] value)
 Sets the value of the Data Object. More...
 

Static Public Member Functions

static ObjectRef< DataObjectIntegerArraycreate (Domain domain, String name)
 Constructs a new DataObjectIntegerArray. More...
 
static ObjectRef< DataObjectIntegerArraycreate (Domain domain, String name, Integer[] defaultValue)
 Constructs a new DataObjectIntegerArray with a default value. More...
 

Static Public Attributes

static final Metaclass metaclass = new Metaclass("Kanzi.DataObjectIntegerArray")
 The Metaclass for the class.
 

Protected Member Functions

void initialize ()
 

Detailed Description

The DataObjectIntegerArray class is used to model an Integer array as a Kanzi DataObjectList with a DataObjectInt as each element.

Member Function Documentation

◆ acquireItem()

DataObject acquireItem ( int  index)

Acquires an item from the list at the provided index.

Parameters
indexThe item index
Returns
The DataObject from the specified index

◆ create() [1/2]

static ObjectRef<DataObjectIntegerArray> create ( Domain  domain,
String  name 
)
static

Constructs a new DataObjectIntegerArray.

Parameters
domainUI Domain where this object belongs.
nameName of the object.

◆ create() [2/2]

static ObjectRef<DataObjectIntegerArray> create ( Domain  domain,
String  name,
Integer []  defaultValue 
)
static

Constructs a new DataObjectIntegerArray with a default value.

Parameters
domainUI Domain where this object belongs.
nameName of the object.
defaultValueThe default value.

◆ getItemTemplate()

ObjectRef<DataObjectInt> getItemTemplate ( )

Returns tree structure of the data source for individual list item.

Only hierarchy and object types are valid, the data might not be.

Returns
template of an individual item

◆ getValue()

Integer [] getValue ( )

Gets the value of the list as an Integer Array.

Returns
An Integer array representation of the current value.

◆ itemCount()

int itemCount ( )

Gets the count of items in the list.

Returns
number of items in the list

◆ releaseItem()

void releaseItem ( int  index)

Releases the memory resources associated with a particular item.

Parameters
indexThe item index.

◆ setValue()

void setValue ( Integer []  value)

Sets the value of the Data Object.

Parameters
valueThe new Integer Array value.