Interface IList<E>

Concurrent and distributed list.

Methods that require serialization/deserialization may throw RangeError, e.g when there is no suitable serializer for a certain type.

Type Parameters

Hierarchy

DistributedObject
- IList

Methods

add

add(element: E): Promise<boolean>
Appends the specified element to the end of the list.

Returns
true if this list has changed as a result of this operation, false otherwise.
Parameters
- element: E
  
  element to be added
Returns Promise<boolean>
- Defined in src/proxy/IList.ts:34

addAll

addAll(elements: E[]): Promise<boolean>
Appends all elements in the specified array to the end of this list, keeping the order of the array.

Returns
true if this list has changed as a result of this operation, false otherwise.
Parameters
- elements: E[]
  
  array to be appended
Returns Promise<boolean>
- Defined in src/proxy/IList.ts:49

addAllAt

addAllAt(index: number, elements: E[]): Promise<boolean>
Inserts all elements in the specified array at specified index, keeping the order of the array. Shifts the subsequent elements to the right.

Returns
true if this list has changed as a result of this operation, false otherwise.
Parameters
- index: number
  
  position at which the array's elements should be inserted
- elements: E[]
  
  array to be inserted
Returns Promise<boolean>
- Defined in src/proxy/IList.ts:58

addAt

addAt(index: number, element: E): Promise<void>
Inserts the specified element at the specified index. Shifts the subsequent elements to the right.
Parameters
- index: number
  
  position at which the element should be inserted
- element: E
  
  element to be inserted
Returns Promise<void>
- Defined in src/proxy/IList.ts:42

addItemListener

addItemListener(listener: ItemListener<E>, includeValue: boolean): Promise<string>
Adds an item listener for this list. Listener will be invoked whenever an item is added to or removed from this list.

Returns
registration ID of the listener.
Parameters
- listener: ItemListener<E>
  
  object with listener functions
- includeValue: boolean
  
  true if updated item should be included in the event.
Returns Promise<string>
- Defined in src/proxy/IList.ts:67

clear

clear(): Promise<void>
Removes all of the elements from this list.

Returns Promise<void>
- Defined in src/proxy/IList.ts:72

contains

contains(element: E): Promise<boolean>
Checks if the list contains the given element.

Returns
true if this list contains the specified element, false otherwise.
Parameters
- element: E
Returns Promise<boolean>
- Defined in src/proxy/IList.ts:79

containsAll

containsAll(elements: E[]): Promise<boolean>
Checks if the list contains all of the elements of the specified array.

Returns
true if this list contains all of the elements of the specified array, false otherwise.
Parameters
- elements: E[]
  
  elements to be checked for presence in this list.
Returns Promise<boolean>
- Defined in src/proxy/IList.ts:86

destroy

destroy(): Promise<void>
Destroys this object cluster-wide. Clears all resources taken for this object.

Returns Promise<void>
Inherited from DistributedObject.destroy
- Defined in src/core/DistributedObject.ts:43

get

get(index: number): Promise<E>
Returns the element at the specified position in this list.
Parameters
- index: number
  
  index of the element to return.
Returns Promise<E>
- Defined in src/proxy/IList.ts:92

getName

getName(): string
Returns the unique name of this object.

Returns string
Inherited from DistributedObject.getName
- Defined in src/core/DistributedObject.ts:32

getPartitionKey

getPartitionKey(): string
Returns the key of the partition that this DistributedObject is assigned to. For a partitioned data structure, the returned value will not be null, but otherwise undefined.

Returns string
Inherited from DistributedObject.getPartitionKey
- Defined in src/core/DistributedObject.ts:27

getServiceName

getServiceName(): string
Returns the service name for this object.

Returns string
Inherited from DistributedObject.getServiceName
- Defined in src/core/DistributedObject.ts:37

indexOf

indexOf(element: E): Promise<number>
Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
Parameters
- element: E
  
  element to search for
Returns Promise<number>
- Defined in src/proxy/IList.ts:99

isEmpty

isEmpty(): Promise<boolean>
Checks if this list is empty.

Returns
true if this list contains no elements, false otherwise.

Returns Promise<boolean>
- Defined in src/proxy/IList.ts:105

lastIndexOf

lastIndexOf(element: E): Promise<number>
Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
Parameters
- element: E
Returns Promise<number>
- Defined in src/proxy/IList.ts:112

remove

remove(element: E): Promise<boolean>
Removes the first occurrence of the specified element from this list, if it is present.

Returns
true if this list has changed as a result of this operation, false otherwise.
Parameters
- element: E
  
  element to be removed
Returns Promise<boolean>
- Defined in src/proxy/IList.ts:119

removeAll

removeAll(elements: E[]): Promise<boolean>
Removes from this list all of its elements that are contained in the specified array.

Returns
true if this list has changed as a result of this operation, false otherwise.
Parameters
- elements: E[]
  
  elements to be removed
Returns Promise<boolean>
- Defined in src/proxy/IList.ts:133

removeAt

removeAt(index: number): Promise<E>
Removes the element at the specified position in this list.

Returns
the removed element.
Parameters
- index: number
  
  index of the element to be removed.
Returns Promise<E>
- Defined in src/proxy/IList.ts:126

removeItemListener

removeItemListener(listenerId: string): Promise<boolean>
Removes an ItemListener from this list.

Returns
true if the item listener was successfully removed, false otherwise.
Parameters
- listenerId: string
  
  registration ID of the listener to be removed.
Returns Promise<boolean>
- Defined in src/proxy/IList.ts:140

retainAll

retainAll(elements: E[]): Promise<boolean>
Retains only the elements in this list that are contained in the specified array.

Returns
true if this list has changed as a result of this operation, false otherwise.
Parameters
- elements: E[]
  
  elements to retain
Returns Promise<boolean>
- Defined in src/proxy/IList.ts:147

set

set(index: number, element: E): Promise<E>
Replaces the element at the specified position in this list with the specified element.

Returns
previous element at the given index.
Parameters
- index: number
  
  position of the element to be replaced
- element: E
  
  replacement element
Returns Promise<E>
- Defined in src/proxy/IList.ts:155

size

size(): Promise<number>
Returns the number of elements in this list.

Returns Promise<number>
- Defined in src/proxy/IList.ts:160

subList

subList(start: number, end: number): Promise<ReadOnlyLazyList<E>>
Returns a view of this list that contains elements between index numbers from start (inclusive) to end (exclusive)

Returns
a view of the list
Parameters
- start: number
  
  start of the view
- end: number
  
  end of the view
Returns Promise<ReadOnlyLazyList<E>>
- Defined in src/proxy/IList.ts:170

toArray

toArray(): Promise<E[]>
Returns an array that contains all elements of this list in proper sequence (from first to last element).

Returns Promise<E[]>
- Defined in src/proxy/IList.ts:175

Interface IList<E>

Type Parameters

E

Hierarchy

Index

Methods

Methods

add

Returns

Parameters

element: E

Returns Promise<boolean>

addAll

Returns

Parameters

elements: E[]

Returns Promise<boolean>

addAllAt

Returns

Parameters

index: number

elements: E[]

Returns Promise<boolean>

addAt

Parameters

index: number

element: E

Returns Promise<void>

addItemListener

Returns

Parameters

listener: ItemListener<E>

includeValue: boolean

Returns Promise<string>

clear

Returns Promise<void>

contains

Returns

Parameters

element: E

Returns Promise<boolean>

containsAll

Returns

Parameters

elements: E[]

Returns Promise<boolean>

destroy

Returns Promise<void>

get

Parameters

index: number

Returns Promise<E>

getName

Returns string

getPartitionKey

Returns string

getServiceName

Returns string

indexOf

Parameters

element: E

Returns Promise<number>

isEmpty

Returns

Returns Promise<boolean>

lastIndexOf

Parameters

element: E

Returns Promise<number>

remove

Returns

Parameters

element: E

Returns Promise<boolean>

removeAll

Returns

Parameters

elements: E[]

Returns Promise<boolean>

removeAt