Class SyncReferenceCollection<K, V>

Synchronous implementation of AbstractReferenceCollection that requires the client to provide a value factory, used to service the acquire() function.

Type Parameters

K
V extends Disposable

Hierarchy (View Summary)

AbstractReferenceCollection<K, V>
- SyncReferenceCollection

Index

Constructors

constructor

new SyncReferenceCollection<K, V extends Disposable>(
factory: (key: K) => V,
): SyncReferenceCollection<K, V>
Type Parameters
- K
- V extends Disposable
Parameters
- factory: (key: K) => V
Returns SyncReferenceCollection<K, V>
Overrides AbstractReferenceCollection.constructor
- Defined in packages/core/src/common/reference.ts:208

Properties

`Protected` `Readonly`_keys

_keys: Map<string, K> = ...

`Protected` `Readonly`_values

_values: Map<string, V> = ...

`Protected` `Readonly`factory

factory: (key: K) => V

`Readonly`onDidCreate

onDidCreate: Event<V> = ...

`Protected` `Readonly`onDidCreateEmitter

onDidCreateEmitter: Emitter<V> = ...

`Readonly`onWillDispose

onWillDispose: Event<V> = ...

`Protected` `Readonly`onWillDisposeEmitter

onWillDisposeEmitter: Emitter<V> = ...

`Protected` `Readonly`references

references: Map<string, DisposableCollection> = ...

`Protected` `Readonly`toDispose

toDispose: DisposableCollection = ...

Methods

acquire

acquire(args: K): Reference<V>
Parameters
- args: K
Returns Reference<V>
Overrides AbstractReferenceCollection.acquire
- Defined in packages/core/src/common/reference.ts:212

clear

clear(): void
Returns void
Inherited from AbstractReferenceCollection.clear
- Defined in packages/core/src/common/reference.ts:93

`Protected`createReferences

createReferences(key: string, value: V): DisposableCollection
Parameters
- key: string
- value: V
Returns DisposableCollection
Inherited from AbstractReferenceCollection.createReferences
- Defined in packages/core/src/common/reference.ts:137

dispose

dispose(): void
Dispose this object.

Returns void
Inherited from AbstractReferenceCollection.dispose
- Defined in packages/core/src/common/reference.ts:89

`Protected`doAcquire

doAcquire(key: string, object: V): Reference<V>
Parameters
- key: string
- object: V
Returns Reference<V>
Inherited from AbstractReferenceCollection.doAcquire
- Defined in packages/core/src/common/reference.ts:123

get

get(args: K): undefined | V
Parameters
- args: K
Returns undefined | V
Inherited from AbstractReferenceCollection.get
- Defined in packages/core/src/common/reference.ts:116

`Protected`getOrCreateValue

getOrCreateValue(key: string, args: K): V
Parameters
- key: string
- args: K
Returns V
- Defined in packages/core/src/common/reference.ts:218

has

has(args: K): boolean
Parameters
- args: K
Returns boolean
Inherited from AbstractReferenceCollection.has
- Defined in packages/core/src/common/reference.ts:103

keys

keys(): K[]
Returns K[]
Inherited from AbstractReferenceCollection.keys
- Defined in packages/core/src/common/reference.ts:108

`Protected`toKey

toKey(args: K): string
Parameters
- args: K
Returns string
Inherited from AbstractReferenceCollection.toKey
- Defined in packages/core/src/common/reference.ts:133

values

values(): V[]
Returns V[]
Inherited from AbstractReferenceCollection.values
- Defined in packages/core/src/common/reference.ts:112

Class SyncReferenceCollection<K, V>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SyncReferenceCollection<K, V>

Properties

Protected Readonly_keys

Protected Readonly_values

Protected Readonlyfactory

ReadonlyonDidCreate

Protected ReadonlyonDidCreateEmitter

ReadonlyonWillDispose

Protected ReadonlyonWillDisposeEmitter

Protected Readonlyreferences

Protected ReadonlytoDispose

Methods

acquire

Parameters

Returns Reference<V>

clear

Returns void

ProtectedcreateReferences

Parameters

Returns DisposableCollection

dispose

Returns void

ProtecteddoAcquire

Parameters

Returns Reference<V>

get

Parameters

Returns undefined | V

ProtectedgetOrCreateValue

Parameters

Returns V

has

Parameters

Returns boolean

keys

Returns K[]

ProtectedtoKey

Parameters

Returns string

values

Returns V[]

Settings

On This Page

`Protected` `Readonly`_keys

`Protected` `Readonly`_values

`Protected` `Readonly`factory

`Readonly`onDidCreate

`Protected` `Readonly`onDidCreateEmitter

`Readonly`onWillDispose

`Protected` `Readonly`onWillDisposeEmitter

`Protected` `Readonly`references

`Protected` `Readonly`toDispose

`Protected`createReferences

`Protected`doAcquire

`Protected`getOrCreateValue

`Protected`toKey