Interface List<T>

Type parameters

T

Hierarchy

ImmutableList<T>
Collection<T>
- List

Implemented by

Index

Methods

Methods

__@iterator

__@iterator(): Iterator<T>

Inherited from ImmutableCollection.__@iterator

Overrides ImmutableCollection.__@iterator
- Defined in ImmutableCollection.ts:52
Returns Iterator<T>

the TypeScript style iterator

add

add(t: T): boolean

Overrides Collection.add
- Defined in List.ts:64
Parameters
- t: T
Returns boolean

true if this collection changed as a result of the call

addAll

addAll(c: ImmutableCollection<T>, index: number): boolean

- Defined in List.ts:79
Parameters
- c: ImmutableCollection<T>
- Optional index: number
Returns boolean

true if this collection changed as a result of the call

addIndex

addIndex(index: number, t: T): void

- Defined in List.ts:71
Parameters
- index: number
- t: T
Returns void

clear

clear(): void

Overrides Collection.clear
- Defined in List.ts:84
Returns void

contains

contains(t: T): boolean

Inherited from ImmutableList.contains

Overrides ImmutableCollection.contains
- Defined in ImmutableList.ts:65
Parameters
- t: T
Returns boolean

true if this list contains the specified element

forEach

forEach(action: Consumer<T>): void

Inherited from ImmutableCollection.forEach

Overrides ImmutableCollection.forEach
- Defined in ImmutableCollection.ts:66
Parameters
- action: Consumer<T>
Returns void

get

get(index: number): T

Inherited from ImmutableList.get
- Defined in ImmutableList.ts:44
Parameters
- index: number
Returns T

the element at the specified position in this list

immutableCollection

immutableCollection(): ImmutableCollection<T>

Inherited from Collection.immutableCollection
- Defined in Collection.ts:68
Returns ImmutableCollection<T>

immutableList

immutableList(): ImmutableList<T>

- Defined in List.ts:96
Returns ImmutableList<T>

indexOf

indexOf(t: T): number

Inherited from ImmutableList.indexOf
- Defined in ImmutableList.ts:51
Parameters
- t: T
Returns number

the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element

isEmpty

isEmpty(): boolean

Inherited from ImmutableList.isEmpty

Overrides ImmutableCollection.isEmpty
- Defined in ImmutableList.ts:71
Returns boolean

true if this list contains no elements

iterator

iterator(): JIterator<T>

Inherited from ImmutableCollection.iterator

Overrides ImmutableCollection.iterator
- Defined in ImmutableCollection.ts:46
Returns JIterator<T>

the Java style iterator

lastIndexOf

lastIndexOf(t: T): number

Inherited from ImmutableList.lastIndexOf
- Defined in ImmutableList.ts:58
Parameters
- t: T
Returns number

the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element

remove

remove(t: T): boolean

Inherited from Collection.remove
- Defined in Collection.ts:63
Parameters
- t: T
Returns boolean

true if this collection contained the specified element

removeAll

removeAll(c: ImmutableCollection<T>): boolean

- Defined in List.ts:91
Parameters
- c: ImmutableCollection<T>
Returns boolean

true if this list changed as a result of the call

removeIndex

removeIndex(index: number): T

- Defined in List.ts:57
Parameters
- index: number
Returns T

the element that was removed from the list, undefined if the element does not exist

set

set(index: number, element: T): T

- Defined in List.ts:50
Parameters
- index: number
- element: T
Returns T

the element previously at the specified position

size

size(): number

Inherited from ImmutableCollection.size

Overrides ImmutableCollection.size
- Defined in ImmutableCollection.ts:34
Returns number

the number of elements in this collection

Generated using TypeDoc