MyChannels.Nirvana.Properties Class Reference

Used to retrieve or store properties on a message. More...

Inheritance diagram for MyChannels.Nirvana.Properties:
MyChannels.Nirvana.IProperties

Public Member Functions

object Get (string key)
 Get the object that matches the specified key More...
 
bool GetBoolean (string key)
 Get the boolean object that matches the specified key More...
 
bool[] GetBooleanArray (string key)
 Get the boolean array that matches the specified key More...
 
byte GetByte (string key)
 Get the byte object that matches the specified key More...
 
byte[] GetByteArray (string key)
 Get the byte array that matches the specified key More...
 
char GetChar (string key)
 Get the char object that matches the specified key More...
 
char[] GetCharArray (string key)
 Get the char array that matches the specified key More...
 
double GetDouble (string key)
 Get the double object that matches the specified key More...
 
double[] GetDoubleArray (string key)
 Get the double array that matches the specified key More...
 
IEnumerator< KeyValuePair
< string, object > > 
GetEnumerator ()
 Allows caller to enumerate all properties. More...
 
float GetFloat (string key)
 Get the float object that matches the specified key More...
 
float[] GetFloatArray (string key)
 Get the float array that matches the specified key More...
 
int GetInt (string key)
 Get the int object that matches the specified key More...
 
int[] GetIntArray (string key)
 Get the int array that matches the specified key More...
 
long GetLong (string key)
 Get the long object that matches the specified key More...
 
long[] GetLongArray (string key)
 Get the long array that matches the specified key More...
 
IProperties GetProperties (string key)
 Get the IProperties object that matches the specified key More...
 
IProperties[] GetPropertiesArray (string key)
 Get the IProperties array that matches the specified key More...
 
string GetString (string key)
 Get the string object that matches the specified key More...
 
string[] GetStringArray (string key)
 Get the string array that matches the specified key More...
 
 Properties ()
 Instantiate a Properties object. More...
 
void Remove (string key)
 Remove the specified key & associated value More...
 
void Set (string key, object val)
 Put the specified object in the Properties against the specific key More...
 
void Set (string key, string val)
 Put the specified string in the Properties against the specific key More...
 
void Set (string key, int val)
 Put the specified int in the Properties against the specific key More...
 
void Set (string key, long val)
 Put the specified long in the Properties against the specific key More...
 
void Set (string key, byte val)
 Put the specified byte in the Properties against the specific key More...
 
void Set (string key, bool val)
 Put the specified bool in the Properties against the specific key More...
 
void Set (string key, char val)
 Put the specified char in the Properties against the specific key More...
 
void Set (string key, IProperties val)
 Put the specified IProperties in the Properties against the specific key More...
 
void Set (string key, float val)
 Put the specified float in the Properties against the specific key More...
 
void Set (string key, double val)
 Put the specified double in the Properties against the specific key More...
 
void Set (string key, string[] val)
 Put the specified string array in the Properties against the specific key More...
 
void Set (string key, int[] val)
 Put the specified int array in the Properties against the specific key More...
 
void Set (string key, long[] val)
 Put the specified long array in the Properties against the specific key More...
 
void Set (string key, byte[] val)
 Put the specified byte array in the Properties against the specific key More...
 
void Set (string key, bool[] val)
 Put the specified bool array in the Properties against the specific key More...
 
void Set (string key, char[] val)
 Put the specified char array in the Properties against the specific key More...
 
void Set (string key, IProperties[] val)
 Put the specified IProperties array in the Properties against the specific key More...
 
void Set (string key, float[] val)
 Put the specified float array in the Properties against the specific key More...
 
void Set (string key, double[] val)
 Put the specified double array in the Properties against the specific key More...
 

Properties

bool IsReadonly [get]
 True: The message properties are read-only, False: You can store properties on this message. More...
 
IEnumerable< string > Keys [get]
 Get an enumeration of the keys More...
 
- Properties inherited from MyChannels.Nirvana.IProperties
bool IsReadonly [get]
 True: The message properties are read-only, False: You can store properties on this message. More...
 
IEnumerable< string > Keys [get]
 Get an enumeration of the keys More...
 
object this[string key] [get, set]
 Gets or sets the value associated with the specified key. More...
 

Detailed Description

Used to retrieve or store properties on a message.

Constructor & Destructor Documentation

MyChannels.Nirvana.Properties.Properties ( )

Instantiate a Properties object.

Member Function Documentation

object MyChannels.Nirvana.Properties.Get ( string  key)

Get the object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

bool MyChannels.Nirvana.Properties.GetBoolean ( string  key)

Get the boolean object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

bool [] MyChannels.Nirvana.Properties.GetBooleanArray ( string  key)

Get the boolean array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

byte MyChannels.Nirvana.Properties.GetByte ( string  key)

Get the byte object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

byte [] MyChannels.Nirvana.Properties.GetByteArray ( string  key)

Get the byte array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

char MyChannels.Nirvana.Properties.GetChar ( string  key)

Get the char object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

char [] MyChannels.Nirvana.Properties.GetCharArray ( string  key)

Get the char array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

double MyChannels.Nirvana.Properties.GetDouble ( string  key)

Get the double object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

double [] MyChannels.Nirvana.Properties.GetDoubleArray ( string  key)

Get the double array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

IEnumerator<KeyValuePair<string, object> > MyChannels.Nirvana.Properties.GetEnumerator ( )

Allows caller to enumerate all properties.

float MyChannels.Nirvana.Properties.GetFloat ( string  key)

Get the float object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

float [] MyChannels.Nirvana.Properties.GetFloatArray ( string  key)

Get the float array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

int MyChannels.Nirvana.Properties.GetInt ( string  key)

Get the int object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

int [] MyChannels.Nirvana.Properties.GetIntArray ( string  key)

Get the int array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

long MyChannels.Nirvana.Properties.GetLong ( string  key)

Get the long object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

long [] MyChannels.Nirvana.Properties.GetLongArray ( string  key)

Get the long array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

IProperties MyChannels.Nirvana.Properties.GetProperties ( string  key)

Get the IProperties object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

IProperties [] MyChannels.Nirvana.Properties.GetPropertiesArray ( string  key)

Get the IProperties array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

string MyChannels.Nirvana.Properties.GetString ( string  key)

Get the string object that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

string [] MyChannels.Nirvana.Properties.GetStringArray ( string  key)

Get the string array that matches the specified key

Parameters
keyThe key to return the value for
Returns
The value

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Remove ( string  key)

Remove the specified key & associated value

Parameters
keyThe key to remove

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
object  val 
)

Put the specified object in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
string  val 
)

Put the specified string in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
int  val 
)

Put the specified int in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
long  val 
)

Put the specified long in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
byte  val 
)

Put the specified byte in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
bool  val 
)

Put the specified bool in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
char  val 
)

Put the specified char in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
IProperties  val 
)

Put the specified IProperties in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
float  val 
)

Put the specified float in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
double  val 
)

Put the specified double in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
string[]  val 
)

Put the specified string array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
int[]  val 
)

Put the specified int array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
long[]  val 
)

Put the specified long array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
byte[]  val 
)

Put the specified byte array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
bool[]  val 
)

Put the specified bool array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
char[]  val 
)

Put the specified char array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
IProperties[]  val 
)

Put the specified IProperties array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
float[]  val 
)

Put the specified float array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

void MyChannels.Nirvana.Properties.Set ( string  key,
double[]  val 
)

Put the specified double array in the Properties against the specific key

Parameters
keythe key to store this value against
valthe value to store

Implements MyChannels.Nirvana.IProperties.

Property Documentation

bool MyChannels.Nirvana.Properties.IsReadonly
get

True: The message properties are read-only, False: You can store properties on this message.

IEnumerable<string> MyChannels.Nirvana.Properties.Keys
get

Get an enumeration of the keys