Class Collection<T, TCollection>

A collection of values.

Type parameters

T
TCollection: Collection<T, TCollection>

Hierarchy

Collection

Index

Constructors

constructor

Properties

Constructors

constructor

new Collection(): Collection

- Defined in fm.icelink/Collection.ts:19
Returns Collection

Properties

Private __values

__values: Array<T>

internal

Private __valuesLock

__valuesLock: Object

internal

Methods

add

add(value: T): boolean

- Defined in fm.icelink/Collection.ts:43
Adds a value.

Parameters
- value: T
  
  The value.
Returns boolean

addMany

addMany(values: T[]): boolean

- Defined in fm.icelink/Collection.ts:66
Adds some values.

Parameters
- values: T[]
  
  The values.
Returns boolean

Protected addSuccess

addSuccess(value: T): void

- Defined in fm.icelink/Collection.ts:89
Invoked when an element is added to the collection.

Parameters
- value: T
  
  The value.
Returns void

any

any(predicate: IFunction1<T, boolean>): boolean
any(): boolean

- Defined in fm.icelink/Collection.ts:105
Determined whether the collection contains at least one value that matches the specified predicate.

Parameters
- predicate: IFunction1<T, boolean>
  
  The predicate.
Returns boolean
- Defined in fm.icelink/Collection.ts:115
Determined whether the collection contains at least one value.

Returns boolean

Protected Abstract arrayFromList

arrayFromList(list: Array<T>): T[]

- Defined in fm.icelink/Collection.ts:140
Creates an array from a list.

Parameters
- list: Array<T>
  
  The list.
Returns T[]

contains

contains(value: T): boolean

- Defined in fm.icelink/Collection.ts:150
Determines whether the collection contains a value.

Parameters
- value: T
  
  The value.
Returns boolean

Protected Abstract createCollection

createCollection(): TCollection

- Defined in fm.icelink/Collection.ts:169
Creates a collection.

Returns TCollection

first

first(predicate: IFunction1<T, boolean>): T
first(): T

- Defined in fm.icelink/Collection.ts:182
Gets the first value that matches the specified predicate. Throws an exception if there are no such values in the collection.

Parameters
- predicate: IFunction1<T, boolean>
  
  The predicate.
Returns T
- Defined in fm.icelink/Collection.ts:194
Gets the first value. Throws an exception if there are no values in the collection.

Returns T

firstOrDefault

firstOrDefault(): T
firstOrDefault(predicate: IFunction1<T, boolean>): T

- Defined in fm.icelink/Collection.ts:224
Gets the first value. Returns a default value if there are no values in the collection.

Returns T
- Defined in fm.icelink/Collection.ts:237
Gets the first value that matches the specified predicate. Returns a default value if there are no such values in the collection.

Parameters
- predicate: IFunction1<T, boolean>
  
  The predicate.
Returns T

forEach

forEach(callback: IAction2<T, number>): void

- Defined in fm.icelink/Collection.ts:263
Executes a callback function once per value.

Parameters
- callback: IAction2<T, number>
  
  The callback to execute.
Returns void

getCount

getCount(): number

- Defined in fm.icelink/Collection.ts:282
Gets the count.

Returns number

getTypeString

getTypeString(): string

- Defined in fm.icelink/Collection.ts:9
Returns string

getValue

getValue(): T

- Defined in fm.icelink/Collection.ts:298
Gets the value.

Returns T

getValues

getValues(): T[]

- Defined in fm.icelink/Collection.ts:317
Gets the values.

Returns T[]

last

last(predicate: IFunction1<T, boolean>): T
last(): T

- Defined in fm.icelink/Collection.ts:336
Gets the last value that matches the specified predicate. Throws an exception if there are no such values in the collection.

Parameters
- predicate: IFunction1<T, boolean>
  
  The predicate.
Returns T
- Defined in fm.icelink/Collection.ts:348
Gets the last value. Throws an exception if there are no values in the collection.

Returns T

lastOrDefault

lastOrDefault(predicate: IFunction1<T, boolean>): T
lastOrDefault(): T

- Defined in fm.icelink/Collection.ts:379
Gets the last value that matches the specified predicate. Returns a default value if there are no such values in the collection.

Parameters
- predicate: IFunction1<T, boolean>
  
  The predicate.
Returns T
- Defined in fm.icelink/Collection.ts:391
Gets the last value. Returns a default value if there are no values in the collection.

Returns T

remove

remove(value: T): boolean

- Defined in fm.icelink/Collection.ts:417
Removes a value.

Parameters
- value: T
  
  The value.
Returns boolean

removeAll

removeAll(): void

- Defined in fm.icelink/Collection.ts:439
Removes all values.

Returns void

removeFirst

removeFirst(condition: IFunction1<T, boolean>): T
removeFirst(): T

- Defined in fm.icelink/Collection.ts:460
Removes the first value that matches a given condition.

Parameters
- condition: IFunction1<T, boolean>
Returns T
- Defined in fm.icelink/Collection.ts:470
Removes the first value.

Returns T

removeLast

removeLast(): T
removeLast(condition: IFunction1<T, boolean>): T

- Defined in fm.icelink/Collection.ts:501
Removes the last value.

Returns T
- Defined in fm.icelink/Collection.ts:512
Removes the last value that matches a given condition.

Parameters
- condition: IFunction1<T, boolean>
Returns T

removeMany

removeMany(values: T[]): boolean

- Defined in fm.icelink/Collection.ts:543
Removes some values.

Parameters
- values: T[]
  
  The values.
Returns boolean

Protected removeSuccess

removeSuccess(value: T): void

- Defined in fm.icelink/Collection.ts:569
Invoked when an element is removed from the collection.

Parameters
- value: T
  
  The value.
Returns void

replace

replace(values: T[]): void

- Defined in fm.icelink/Collection.ts:584
Replaces the collection with a new set of values.

Parameters
- values: T[]
  
  The values.
Returns void

setValue

setValue(value: T): void

- Defined in fm.icelink/Collection.ts:604
Sets the value.

Parameters
- value: T
Returns void

setValues

setValues(value: T[]): void

- Defined in fm.icelink/Collection.ts:624
Sets the values.

Parameters
- value: T[]
Returns void

single

single(predicate: IFunction1<T, boolean>): T
single(): T

- Defined in fm.icelink/Collection.ts:648
Gets the only value that matches the specified predicate. Throws an exception if there are no values or more than one value in the collection.

Parameters
- predicate: IFunction1<T, boolean>
Returns T
- Defined in fm.icelink/Collection.ts:661
Gets the only value. Throws an exception if there are no values or more than one value in the collection.

Returns T

singleOrDefault

singleOrDefault(): T
singleOrDefault(predicate: IFunction1<T, boolean>): T

- Defined in fm.icelink/Collection.ts:692
Gets the only value. Returns a default value if there are no values or more than one value in the collection.

Returns T
- Defined in fm.icelink/Collection.ts:707
Gets the only value that matches the specified predicate. Returns a default value if there are no values or more than one value in the collection.

Parameters
- predicate: IFunction1<T, boolean>
Returns T

valueAt

valueAt(index: number): T

- Defined in fm.icelink/Collection.ts:735
Gets the value at the specified index. Throws an exception if a value does not exist at that index.

Parameters
- index: number
  
  The index.
Returns T

valueAtOrDefault

valueAtOrDefault(index: number): T

- Defined in fm.icelink/Collection.ts:757
Gets the value at the specified index. Returns a default value if a value does not exist at that index.

Parameters
- index: number
  
  The index.
Returns T

where

where(predicate: IFunction2<T, number, boolean>): TCollection

- Defined in fm.icelink/Collection.ts:781
Creates a new collection with values that match the specified predicate.

Parameters
- predicate: IFunction2<T, number, boolean>
  
  The predicate.
Returns TCollection