Class PreferenceSchemaServiceImpl

Implements

PreferenceSchemaService

Constructors

constructor

new PreferenceSchemaServiceImpl(): PreferenceSchemaServiceImpl
Returns PreferenceSchemaServiceImpl

Properties

`Protected` `Readonly`_overrideIdentifiers

_overrideIdentifiers: Set<string> = ...

`Protected` `Readonly`_ready

_ready: Deferred<void> = ...

`Protected` `Readonly`defaultOverrides

defaultOverrides: Map<string, Map<string | object, [number, JSONValue][]>> = ...

This map stores default overrides. The primary map key is the base preference name. The preference name maps to a second map keyed by the override identifier or a special object value `NO_OVERRIDE', representing default overrides for the base property. The value in this second map is an array of entries in reverse order of their insertion. This is necessary becuaus multiple clients might register overrides for the same preference key/override combination. The elements in this array consist of a unique, generated identifier and the actual override value. This allows us to always return the last registerd override even when overrides are later removed.

`Protected` `Readonly`defaultValueChangedEmitter

defaultValueChangedEmitter: Emitter<DefaultValueChangedEvent> = ...

Event emitters

`Protected` `Readonly`jsonSchemas

jsonSchemas: IJSONSchema[] = []

`Protected`nextOverrideValueId

nextOverrideValueId: number = 1

`Protected`nextSchemaTitle

nextSchemaTitle: number = 1

`Readonly`onDidChangeDefaultValue

onDidChangeDefaultValue: Event<DefaultValueChangedEvent> = ...

Public events

`Readonly`onDidChangeSchema

onDidChangeSchema: Event<void> = ...

`Protected` `Readonly`preferenceContributions

preferenceContributions: ContributionProvider<PreferenceContribution>

`Protected` `Readonly`properties

properties: Map<string, PreferenceDataProperty> = ...

`Protected` `Readonly`schemaChangedEmitter

schemaChangedEmitter: Emitter<void> = ...

`Protected` `Readonly`schemas

schemas: Set<PreferenceSchema> = ...

Storage structures

`Readonly`validScopes

validScopes: readonly PreferenceScope[]

The scopes which this preference schema service handles. Any properties that are not applicable within the valid scopes will be ignored

Accessors

overrideIdentifiers

get overrideIdentifiers(): ReadonlySet<string>
Returns ReadonlySet<string>
Implementation of PreferenceSchemaService.overrideIdentifiers
- Defined in packages/core/src/common/preferences/preference-schema-service.ts:56

ready

get ready(): Promise<void>
Resolves after static contributions have been processed

Returns Promise<void>
Implementation of PreferenceSchemaService.ready
- Defined in packages/core/src/common/preferences/preference-schema-service.ts:52

Methods

addOverrideToJsonSchema

addOverrideToJsonSchema(overrideIdentifier: string): void
Parameters
- overrideIdentifier: string
Returns void
- Defined in packages/core/src/common/preferences/preference-schema-service.ts:390

addSchema

addSchema(schema: PreferenceSchema): Disposable
Add a preference schema. It is an error to register the same property in two different schemas
Parameters
- schema: PreferenceSchema
  The schema to add
Returns Disposable
A disposable to remove the schema
Implementation of PreferenceSchemaService.addSchema
- Defined in packages/core/src/common/preferences/preference-schema-service.ts:123

`Protected`changeFor

changeFor(
    key: string,
    overrideIdentifier: undefined | string,
    overrides: undefined | Map<string | object, [number, JSONValue][]>,
    oldValue: undefined | JSONValue,
    newValue: undefined | JSONValue,
): DefaultValueChangedEvent
Parameters
- key: string
- overrideIdentifier: undefined | string
- overrides: undefined | Map<string | object, [number, JSONValue][]>
- oldValue: undefined | JSONValue
- newValue: undefined | JSONValue
Returns DefaultValueChangedEvent
- Defined in packages/core/src/common/preferences/preference-schema-service.ts:252

dispose

dispose(): void
Returns void
- Defined in packages/core/src/common/preferences/preference-schema-service.ts:103

getDefaultValue

getDefaultValue(
key: string,
overrideIdentifier: undefined | string,
): undefined | JSONValue
Get the default value for a preference. This is the value a client will see for the given key/override
Parameters
- key: string
  The preference key
- overrideIdentifier: undefined | string
  The override identifier, undefined for global default
Returns undefined | JSONValue
The default value or undefined if not found
Implementation of PreferenceSchemaService.getDefaultValue
- Defined in packages/core/src/common/preferences/preference-schema-service.ts:312

getDefaultValues

getDefaultValues(): JSONObject
Get the collection of all defined default values as JSONObject of the form like in a preferences.json

Example usage
```
{
  "my.preference": "a string default",
  "[typescript]": {
     "another.preference": 39
  }
```
Returns JSONObject
Implementation of PreferenceSchemaService.getDefaultValues
- Defined in packages/core/src/common/preferences/preference-schema-service.ts:408

getJSONSchema

getJSONSchema(scope: PreferenceScope): IJSONSchema
Gets a JSON schema a preference.json file for the given scope.
Parameters
- scope: PreferenceScope
  The scope to generate schema for
Returns IJSONSchema
The JSON schema
Implementation of PreferenceSchemaService.getJSONSchema
- Defined in packages/core/src/common/preferences/preference-schema-service.ts:343

inspectDefaultValue

inspectDefaultValue(
key: string,
overrideIdentifier: undefined | string,
): undefined | JSONValue
Gets the default value for a preference. This method not fall back to the global value if no override is given
Parameters
- key: string
  The preference key
- overrideIdentifier: undefined | string
  The override identifier, undefined for global default
Returns undefined | JSONValue
The default value or undefined if not found
Implementation of PreferenceSchemaService.inspectDefaultValue
- Defined in packages/core/src/common/preferences/preference-schema-service.ts:326

isValidInScope

isValidInScope(preferenceName: string, scope: PreferenceScope): boolean
Check if a preference is valid in a specific scope
Parameters
- preferenceName: string
  The preference name
- scope: PreferenceScope
  The scope to check
Returns boolean
True if the preference is valid in the given scope
Implementation of PreferenceSchemaService.isValidInScope
- Defined in packages/core/src/common/preferences/preference-schema-service.ts:176

registerOverride

registerOverride(
    key: string,
    overrideIdentifier: undefined | string,
    value: JSONValue,
): Disposable
Register an override for a preference default value. If multiple overrides are registered for the same value, the last override will be in effect. Removing the last override will make the second-to-last override active, etc.
Parameters
- key: string
  The preference key
- overrideIdentifier: undefined | string
  The override identifier, undefined for global default
- value: JSONValue
  The default value
Returns Disposable
A disposable to unregister the override
Implementation of PreferenceSchemaService.registerOverride
- Defined in packages/core/src/common/preferences/preference-schema-service.ts:212

registerOverrideIdentifier

registerOverrideIdentifier(overrideIdentifier: string): Disposable
Register an override identifier for language specific preferences
Parameters
- overrideIdentifier: string
  The identifier to register
Returns Disposable
A disposable to unregister the identifier
Implementation of PreferenceSchemaService.registerOverrideIdentifier
- Defined in packages/core/src/common/preferences/preference-schema-service.ts:108

`Protected`removeOverride

removeOverride(
    key: string,
    overrideIdentifier: undefined | string,
    overrideValueId: number,
): void
Parameters
- key: string
- overrideIdentifier: undefined | string
- overrideValueId: number
Returns void
- Defined in packages/core/src/common/preferences/preference-schema-service.ts:271

updateSchemaProperty

updateSchemaProperty(key: string, property: PreferenceDataProperty): void
Update a property in the schema. The corresponding JSON Schemas, etc. will be updated
Parameters
- key: string
  The property key
- property: PreferenceDataProperty
  The updated property
Returns void
Implementation of PreferenceSchemaService.updateSchemaProperty
- Defined in packages/core/src/common/preferences/preference-schema-service.ts:194

Class PreferenceSchemaServiceImpl

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns PreferenceSchemaServiceImpl

Properties

Protected Readonly_overrideIdentifiers

Protected Readonly_ready

Protected ReadonlydefaultOverrides

Protected ReadonlydefaultValueChangedEmitter

Protected ReadonlyjsonSchemas

ProtectednextOverrideValueId

ProtectednextSchemaTitle

ReadonlyonDidChangeDefaultValue

ReadonlyonDidChangeSchema

Protected ReadonlypreferenceContributions

Protected Readonlyproperties

Protected ReadonlyschemaChangedEmitter

Protected Readonlyschemas

ReadonlyvalidScopes

Accessors

overrideIdentifiers

Returns ReadonlySet<string>

ready

Returns Promise<void>

Methods

addOverrideToJsonSchema

Parameters

Returns void

addSchema

Parameters

Returns Disposable

ProtectedchangeFor

Parameters

Returns DefaultValueChangedEvent

dispose

Returns void

getDefaultValue

Parameters

Returns undefined | JSONValue

getDefaultValues

Example usage

Returns JSONObject

getJSONSchema

Parameters

Returns IJSONSchema

getSchemaProperties

Returns ReadonlyMap<string, PreferenceDataProperty>

getSchemaProperty

Parameters

Returns undefined | PreferenceDataProperty

Protectedinit

Returns void

inspectDefaultValue

Parameters

Returns undefined | JSONValue

isValidInScope

Parameters

Returns boolean

registerOverride

Parameters

Returns Disposable

registerOverrideIdentifier

Parameters

Returns Disposable

ProtectedremoveOverride

Parameters

Returns void

updateSchemaProperty

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`_overrideIdentifiers

`Protected` `Readonly`_ready

`Protected` `Readonly`defaultOverrides

`Protected` `Readonly`defaultValueChangedEmitter

`Protected` `Readonly`jsonSchemas

`Protected`nextOverrideValueId

`Protected`nextSchemaTitle

`Readonly`onDidChangeDefaultValue

`Readonly`onDidChangeSchema

`Protected` `Readonly`preferenceContributions

`Protected` `Readonly`properties

`Protected` `Readonly`schemaChangedEmitter

`Protected` `Readonly`schemas

`Readonly`validScopes

`Protected`changeFor

`Protected`init

`Protected`removeOverride