Theia API Documentation v1.77.0
    Preparing search index...

    Class AbstractReferenceCollection<K, V>Abstract

    Abstract class for a map of reference-counted disposable objects, with the following features:

    • values are not inserted explicitly; instead, acquire() is used to create the value for a given key, or return the previously created value for it. How the value is created for a given key is implementation specific.

    • any subsquent acquire() with the same key will bump the reference count on that value. acquire() returns not the value directly but a reference object that holds the value. Calling dispose() on the reference decreases the value's effective reference count.

    • a contained value will have its dispose() function called when its reference count reaches zero. The key/value pair will be purged from the collection.

    • calling dispose() on the value directly, instead of calling it on the reference returned by acquire(), will automatically dispose all outstanding references to that value and the key/value pair will be purged from the collection.

    • supports synchronous and asynchronous implementations. acquire() will return a Promise if the value cannot be created immediately

    • functions has|keys|values|get are always synchronous and the result excludes asynchronous additions in flight.

    • functions values|get return the value directly and not a reference to the value. Use these functions to obtain a value without bumping its reference count.

    • clients can register to be notified when values are added and removed; notification for asynchronous additions happen when the creation completes, not when it's requested.

    • keys can be any value/object that can be successfully stringified using JSON.stringify(), sans arguments

    • calling dispose() on the collection will dispose all outstanding references to all contained values, which results in the disposal of the values themselves.

    Type Parameters

    Hierarchy (View Summary)

    Implements

    Index
    _keys: Map<string, K> = ...
    _values: Map<string, V> = ...
    onDidCreate: Event<V> = ...
    onDidCreateEmitter: Emitter<V> = ...
    onWillDispose: Event<V> = ...
    onWillDisposeEmitter: Emitter<V> = ...
    references: Map<string, DisposableCollection> = ...
    toDispose: DisposableCollection = ...