Class FlagMap<T, U>

A map from flags to objects of some other type. Used as a simple wrapper for a dictionary, so that one doesn't constantly have to call .toString() on the flags.

Type parameters

T
The type of the Flag objects used as keys.
U
The type of the values.

Hierarchy

FlagMap

Index

Constructors

constructor

Properties

dictionary

Methods

Constructors

constructor

new FlagMap(): FlagMap

- Defined in src/ts/Data structures/flags.ts:117
Constructor for the FlagMap class.
Returns FlagMap

Properties

dictionary

dictionary: {}

The internal dictionary used to actually do the mapping.

Type declaration

[key: string]: U

Methods

clone

clone(): FlagMap<T, U>

- Defined in src/ts/Data structures/flags.ts:155
Returns FlagMap<T, U>

get

get(key: Flag<T> | string): U

- Defined in src/ts/Data structures/flags.ts:130
Gets the value associated to a flag.
Parameters
- key: Flag<T> | string
  The flag to use as a key.
Returns U
The value associated to the flag.

set

set(key: Flag<T> | string, value: U): void

- Defined in src/ts/Data structures/flags.ts:151
Sets the value associated to a flag.
Parameters
- key: Flag<T> | string
  The flag to use as a key.
- value: U
  The new value that will be associated to the flag.
Returns void

Generated using TypeDoc, the 1/31/2021 at 6:18:55 AM