Class ContextCache<Context, Key, Value, ContextKey>

Copyright 2021 TypeFox GmbH This program and the accompanying materials are made available under the terms of the MIT License, which is available in the project root.

Type Parameters

Context
Key
Value
ContextKey = Context

Hierarchy (view full)

DisposableCache
- ContextCache
  - DocumentCache

Index

Constructors

Properties

isDisposed toDispose

Methods

cacheForContext clear delete dispose get has onDispose set throwIfDisposed

Constructors

constructor

new ContextCache<Context, Key, Value, ContextKey>(converter?): ContextCache<Context, Key, Value, ContextKey>
Type Parameters
- Context
- Key
- Value
- ContextKey = Context
Parameters
- Optionalconverter: ((input: Context) => ContextKey)
  - - (input): ContextKey
    - Parameters
      input: Context
      Returns ContextKey
Returns ContextCache<Context, Key, Value, ContextKey>
Overrides DisposableCache.constructor
- Defined in packages/langium/src/utils/caching.ts:81

Properties

`Protected`isDisposed

isDisposed: boolean = false

`Protected`toDispose

toDispose: Disposable[] = []

Methods

`Protected`cacheForContext

cacheForContext(contextKey): Map<Key, Value>
Parameters
- contextKey: Context
Returns Map<Key, Value>
- Defined in packages/langium/src/utils/caching.ts:129

clear

clear(): void
Returns void
Overrides DisposableCache.clear
- Defined in packages/langium/src/utils/caching.ts:117
clear(contextKey): void
Parameters
- contextKey: Context
Returns void
Overrides DisposableCache.clear
- Defined in packages/langium/src/utils/caching.ts:118

delete

delete(contextKey, key): boolean
Parameters
- contextKey: Context
- key: Key
Returns boolean
- Defined in packages/langium/src/utils/caching.ts:112

dispose

dispose(): void
Dispose this object.

Returns void
Inherited from DisposableCache.dispose
- Defined in packages/langium/src/utils/caching.ts:21

get

get(contextKey, key): undefined | Value
Parameters
- contextKey: Context
- key: Key
Returns undefined | Value
- Defined in packages/langium/src/utils/caching.ts:96
get(contextKey, key, provider): Value
Parameters
- contextKey: Context
- key: Key
- provider: (() => Value)
  - - (): Value
    - Returns Value
Returns Value
- Defined in packages/langium/src/utils/caching.ts:97

has

has(contextKey, key): boolean
Parameters
- contextKey: Context
- key: Key
Returns boolean
- Defined in packages/langium/src/utils/caching.ts:86

onDispose

onDispose(disposable): void
Parameters
- disposable: Disposable
Returns void
Inherited from DisposableCache.onDispose
- Defined in packages/langium/src/utils/caching.ts:17

set

set(contextKey, key, value): void
Parameters
- contextKey: Context
- key: Key
- value: Value
Returns void
- Defined in packages/langium/src/utils/caching.ts:91

`Protected`throwIfDisposed

throwIfDisposed(): void
Returns void
Inherited from DisposableCache.throwIfDisposed
- Defined in packages/langium/src/utils/caching.ts:28