Class: KeySet

Oracle® JavaScript Extension Toolkit (JET)
7.1.0

F18183-01

Signature:

abstract class KeySet<K>

QuickNav


PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

KeySet

Version:
  • 7.1.0
Since:
  • 4.1.0
Module:
  • ojkeyset

Module usage

See JET Module Loading for an overview of module usage within JET.

Javascript Import Format
define(['ojs/ojkeyset'], function(KeySet) {
 // Application should call API on KeySet 
})
Typescript Import Format
//To import this class, use the format below.
import {KeySet} from "ojs/ojkeyset";
Generic Parameters
ParameterDescription
KType of Key

JET In Typescript

A detailed description of working with JET elements and classes in your typescript project can be found at: JET Typescript Usage.

Description

The base class for ExpandedKeySet and ExpandAllKeySet. Represents an immutable set of keys.

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

An immutable set of keys.

Methods

(abstract) add(keys: Set<K>|Array<K>): KeySet<K>

Returns a new KeySet based on this set with the specified keys included.
Parameters:
Name Type Description
keys Set | Array a set of keys to add to this KeySet.
Returns:
a new KeySet with the specified keys included.
Type
KeySet

(abstract) addAll(): KeySet<K>

Returns a new KeySet that signals all keys are added to this set.
Returns:
a new KeySet that signals all keys are added to this set.
Type
KeySet

(abstract) clear(): KeySet<K>

Returns a new KeySet containing no keys.
Returns:
a new KeySet with no keys.
Type
KeySet

(abstract) delete(keys: Set<K>|Array<K>): KeySet<K>

Returns a new KeySet based on this set with the specified keys excluded.
Parameters:
Name Type Description
keys Set | Array a set of keys to remove from this KeySet.
Returns:
a new KeySet with the specified keys excluded.
Type
KeySet

(abstract) has(key) → {boolean}

Returns whether the specified key is contained in this set.
Parameters:
Name Type Description
key K the key to check whether it is contained in this set.
Returns:
true if the specified key is contained in this set, false otherwise.
Type
boolean

(abstract) isAddAll() → {boolean}

Returns whether this set should include all keys.
Returns:
true if this set should include all keys, false otherwise.
Type
boolean