Nonlinear Container PlainArray

NOTE The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import PlainArray from '@ohos.util.PlainArray';  

System Capability

SystemCapability.Utils.Lang

PlainArray

Attributes

constructor

constructor()

A constructor used to create a PlainArray instance.

Example

let plainArray = new PlainArray();

isEmpty

isEmpty(): boolean

Checks whether this container is empty.

Return value

Example

const plainArray = new PlainArray();
let result = plainArray.isEmpty();

has

has(key: number): boolean

Checks whether this container contains the specified key.

Parameters

Return value

Example

let plainArray = new PlainArray();
plainArray.has(1);
plainArray.add(1, "sddfhf");
let result1 = plainArray.has(1);

get

get(key: number): T

Obtains the value of the specified key in this container.

Parameters

Return value

Example

let plainArray = new PlainArray();
plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf");
let result = plainArray.get(1);

getIndexOfKey

getIndexOfKey(key: number): number

Obtains the index of the first occurrence of an entry with the specified key in this container.

Parameters

Return value

Example

let plainArray = new PlainArray();
plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf");
let result = plainArray.getIndexOfKey("sdfs");

getIndexOfValue

getIndexOfValue(value: T): number

Obtains the index of the first occurrence of an entry with the specified value in this container.

Parameters

Return value

Example

let plainArray = new PlainArray();
plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf");
let result = plainArray.getIndexOfValue("sddfhf");

getKeyAt

getKeyAt(index: number): number

Obtains the key of the entry at the specified position in this container.

Parameters

Return value

Example

let plainArray = new PlainArray();
plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf");
let result = plainArray.getKeyAt(1);

getValueAt

getValueAt(index: number): T

Obtains the value of an entry at the specified position in this container.

Parameters

Return value

Example

let plainArray = new PlainArray();
plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf");
let result = plainArray.getKeyAt(1);

clone

clone(): PlainArray<T>

Clones this container and returns a copy. The modification to the copy does not affect the original instance.

Return value

Example

let plainArray = new PlainArray();
plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf");
let newPlainArray = plainArray.clone();

add

add(key: number, value: T): void

Adds an entry to this container.

Parameters

Example

let plainArray = new PlainArray();
plainArray.add(1, "sddfhf");

remove

remove(key: number): T

Removes an entry with the specified key from this container.

Parameters

Return value

Example

let plainArray = new PlainArray();
plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf");
plainArray.remove(2);
let result = plainArray.remove(2);

removeAt

removeAt(index: number): T

Removes an entry at the specified position from this container.

Parameters

Return value

Example

let plainArray = new PlainArray();
plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf");
plainArray.removeAt(1);
let result = plainArray.removeAt(1);

removeRangeFrom

removeRangeFrom(index: number, size: number): number

Removes entries in a specified range from this container.

Parameters

Return value

Example

let plainArray = new PlainArray();
plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf");
let result = plainArray.removeRangeFrom(1, 3);

setValueAt

setValueAt(index: number, value: T): void

Sets a value for an entry at the specified position in this container.

Parameters

Example

let plainArray = new PlainArray();
plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf");
plainArray.setValueAt(1, 3546);

toString

toString(): String

Obtains a string that contains all entries in this container.

Return value

Example

let plainArray = new PlainArray();
plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf");
let result = plainArray.toString();

clear

clear(): void

Clears this container and sets its length to 0.

Example

let plainArray = new PlainArray();
plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf");
plainArray.clear();

forEach

forEach(callbackfn: (value: T, index?: number, PlainArray?: PlainArray<T>) => void, thisArg?: Object): void

Uses a callback to traverse the entries in this container and obtain their position indexes.

Parameters

callbackfn

Example

let plainArray = new PlainArray();
plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf");
plainArray.forEach((value, index) => {
  console.log("value:" + value, index);
});

[Symbol.iterator]

[Symbol.iterator](): IterableIterator<[number, T]>

Obtains an iterator, each item of which is a JavaScript object.

Return value

Example

let plainArray = new PlainArray();
plainArray.add(1, "sddfhf");
plainArray.add(2, "sffdfhf");

// Method 1:
for (let item of plainArray) { 
  console.log("index:" + item[0]);
  console.log("value:" + item[1]);
}

// Method 2:
let iter = plainArray[Symbol.iterator]();
let temp = iter.next().value;
while(temp != undefined) {
  console.log("index:" + temp[0]);
  console.log("value:" + temp[1]);
  temp = iter.next().value;
}