Class: KeySet

Oracle® JavaScript Extension Toolkit (JET)
5.0.0

E90577-01

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:
  • 5.0.0
Since:
  • 4.1.0
Module:
  • ojkeyset
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) → {KeySet}

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}

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}

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

(abstract) delete(keys) → {KeySet}

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 * 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