Askowl.Map Class Reference

A dictionary wrapper More...

Inheritance diagram for Askowl.Map:

Public Member Functions
Map	Remove (object key, bool dispose=true)
	Remove an entry, optionally calling Dispose() More...
Map	Sort ()
	Sort keys ascending alphabetic More...
Map	Sort (Comparison< object > comparison)
	Sort keys using a comparator More...
Map	Add (object key, object value=null)
	Add a map or set entry More...
virtual void	Dispose ()
	Remove all entries - calling Dispose() on each one More...
void	Clear ()
	//#TBD#// More...
Dictionary< string, Tv >	ToDictionary< Tv > ()
	//#TBD#// More...
override string	ToString ()

Public Attributes
object	First => Count > 0 ? keys[index.Start()] : null
	Retrieve the value for the first key entered/sorted More...
object	Next => index.Reached(Count - 1) ? null : keys[index.Next()]
	Retrieve the value for the second key entered/sorted More...
object	this[int i] => keys[i]
	Get a key by index based where 0 is the oldest/sorted More...
object []	Keys => keys.ToArray()
	Array of keys in entry/sorted order More...
int	Count => keys.Count
	Number of entries in the map More...
bool	Found
	Was the last search successful? More...
object	Key
	Last key searched for More...
object	Value
	Last value found (null for failure) More...

Static Public Attributes
static Map	Instance => Cache<Map>.Instance
	//#TBD#// More...

Properties
Map	this[object key] [get]
	Prepare retrieval given a known key More...

Detailed Description

A dictionary wrapper

Definition at line 10 of file Map.cs.

Member Function Documentation

Add()

Map Askowl.Map.Add	(	object	key,
		object	value = null
	)

Add a map or set entry

Definition at line 68 of file Map.cs.

Clear()

void Askowl.Map.Clear

(

)

//#TBD#//

Definition at line 101 of file Map.cs.

Dispose()

virtual void Askowl.Map.Dispose ( )

virtual

Remove all entries - calling Dispose() on each one

Definition at line 89 of file Map.cs.

Remove()

Map Askowl.Map.Remove	(	object	key,
		bool	dispose = true
	)

Remove an entry, optionally calling Dispose()

Definition at line 22 of file Map.cs.

Sort() [1/2]

Map Askowl.Map.Sort

(

)

Sort keys ascending alphabetic

Definition at line 47 of file Map.cs.

Sort() [2/2]

Map Askowl.Map.Sort

(

Comparison< object >

comparison

)

Sort keys using a comparator

Definition at line 53 of file Map.cs.

ToDictionary< Tv >()

Dictionary<string, Tv> Askowl.Map.ToDictionary< Tv >

(

)

//#TBD#//

Type Constraints

Tv

:

class

Definition at line 107 of file Map.cs.

ToString()

override string Askowl.Map.ToString

(

)

Definition at line 117 of file Map.cs.

Member Data Documentation

Count

int Askowl.Map.Count => keys.Count

Number of entries in the map

Definition at line 77 of file Map.cs.

First

object Askowl.Map.First => Count > 0 ? keys[index.Start()] : null

Retrieve the value for the first key entered/sorted

Definition at line 33 of file Map.cs.

Found

bool Askowl.Map.Found

Was the last search successful?

Definition at line 80 of file Map.cs.

Instance

Map Askowl.Map.Instance => Cache<Map>.Instance

static

//#TBD#//

Definition at line 16 of file Map.cs.

Key

object Askowl.Map.Key

Last key searched for

Definition at line 83 of file Map.cs.

Keys

object [] Askowl.Map.Keys => keys.ToArray()

Array of keys in entry/sorted order

Definition at line 44 of file Map.cs.

Next

object Askowl.Map.Next => index.Reached(Count - 1) ? null : keys[index.Next()]

Retrieve the value for the second key entered/sorted

Definition at line 36 of file Map.cs.

this[int i]

object Askowl.Map.this[int i] => keys[i]

Get a key by index based where 0 is the oldest/sorted

Definition at line 41 of file Map.cs.

Value

object Askowl.Map.Value

Last value found (null for failure)

Definition at line 86 of file Map.cs.

Property Documentation

this[object key]

Map Askowl.Map.this[object key]

get

Prepare retrieval given a known key

Definition at line 59 of file Map.cs.

---

The documentation for this class was generated from the following file:

• Map.cs