Nonlinear Container TreeSet

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.

TreeSet is implemented based on TreeMap. In TreeSet, only value objects are processed. TreeSet can be used to store values, each of which must be unique.

HashSet stores data in a random order, whereas TreeSet stores data in sorted order. Both of them allows only unique elements. However, null values are allowed in HashSet, but not allowed in TreeSet.

Recommended use case: Use TreeSet when you need to store data in sorted order.

Modules to Import

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

TreeSet

Attributes

System capability: SystemCapability.Utils.Lang

constructor

constructor(comparator?:(firstValue: T, secondValue: T) => boolean)

A constructor used to create a TreeSet instance.

System capability: SystemCapability.Utils.Lang

Parameters

Example

let treeSet = new TreeSet();

isEmpty

isEmpty(): boolean

Checks whether this container is empty (contains no element).

System capability: SystemCapability.Utils.Lang

Return value

Example

const treeSet = new TreeSet();
let result = treeSet.isEmpty();

has

has(value: T): boolean

Checks whether this container has the specified value.

System capability: SystemCapability.Utils.Lang

Parameters

Return value

Example

let treeSet = new TreeSet();
treeSet.has(123);
treeSet.add(123);
let result1 = treeSet.has(123);

getFirstValue

getFirstValue(): T

Obtains the value of the first element in this container.

System capability: SystemCapability.Utils.Lang

Return value

Example

let treeSet = new TreeSet();
treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
treeSet.add("sdfs");
let result = treeSet.getFirstValue();

getLastValue

getLastValue(): T

Obtains the value of the last element in this container.

System capability: SystemCapability.Utils.Lang

Return value

Example

let treeSet = new TreeSet();
treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
treeSet.add("sdfs");
let result = treeSet.getLastValue();

add

add(value: T): boolean

Adds an element to this container.

System capability: SystemCapability.Utils.Lang

Parameters

Return value

Example

let treeSet = new TreeSet();
let result = treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");

remove

remove(value: T): boolean

Removes the element with the specified key from this container.

System capability: SystemCapability.Utils.Lang

Parameters

Return value

Example

let treeSet = new TreeSet();
treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
treeSet.add("sdfs");
let result = treeSet.remove("sdfs");

getLowerValue

getLowerValue(key: T): T

Obtains the value that is placed in front of the input key in this container.

System capability: SystemCapability.Utils.Lang

Parameters

Return value

Example

let treeSet = new TreeSet();
treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
treeSet.add("sdfs");
treeSet.add("zdfgsd");
let result = treeSet.getLowerValue("sdfs");

getHigherValue

getHigherValue(key: T): T

Obtains the value that is placed next to the input key in this container.

System capability: SystemCapability.Utils.Lang

Parameters

Return value

Example

let treeSet = new TreeSet();
treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
treeSet.add("sdfs");
treeSet.add("zdfgsd");
let result = treeSet.getHigherValue("sdfs");

popFirst

popFirst(): T

Removes the first element in this container.

System capability: SystemCapability.Utils.Lang

Return value

Example

let treeSet = new TreeSet();
treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
treeSet.add("sdfs");
let result = treeSet.popFirst();

popLast

popLast(): T

Removes the last element in this container.

System capability: SystemCapability.Utils.Lang

Return value

Example

let treeSet = new TreeSet();
treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
treeSet.add("sdfs");
let result = treeSet.popLast();

clear

clear(): void

Clears this container and sets its length to 0.

System capability: SystemCapability.Utils.Lang

Example

let treeSet = new TreeSet();
treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
treeSet.add("sdfs");
treeSet.clear();

values

values(): IterableIterator<T>

Obtains an iterator that contains all the values in this container.

System capability: SystemCapability.Utils.Lang

Return value

Example

let treeSet = new TreeSet();
treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
treeSet.add("sdfs");
let iter = treeSet.values();
let temp = iter.next().value;
while(temp != undefined) {
  console.log("value:" + temp);
  temp = iter.next().value;
} 

forEach

forEach(callbackfn: (value?: T, key?: T, set?: TreeSet<T>) => void, thisArg?: Object): void

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

System capability: SystemCapability.Utils.Lang

Parameters

callbackfn

Example

let treeSet = new TreeSet();
treeSet.add("sdfs");
treeSet.add("dfsghsf");
treeSet.forEach((value, key) => {
  console.log("value:" + value, key)
});

entries

entries(): IterableIterator<[T, T]>

Obtains an iterator that contains all the elements in this container.

System capability: SystemCapability.Utils.Lang

Return value

Example

let treeSet = new TreeSet();
treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
treeSet.add("sdfs");
let iter = treeSet.entries();
let temp = iter.next().value;
while(temp != undefined) {
  console.log("key:" + temp[0]);
  console.log("value:" + temp[1]);
  temp = iter.next().value;
}

[Symbol.iterator]

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

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

System capability: SystemCapability.Utils.Lang

Return value

Example

let treeSet = new TreeSet();
treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
treeSet.add("sdfs");
  
// Method 1:
for (let item of treeSet) { 
  console.log("value:" + item);
}

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