com.pcbsys.nirvana.client.nEventPropertiesHelper Class Reference

This class is a helper class for the nEventProperties key,value pairs. More...

Static Public Member Functions
static String	getKey (Object pair)
	Return the key element of the internal EntrySet representation. More...
static String	getKey (Map.Entry< fStringEntry, Object > pair)
	Return the key element of the internal EntrySet representation. More...
static Object	getKey (Object pair, boolean convert)
	Return the key element of the internal EntrySet representation. More...
static Object	getValue (Object pair)
	Return the value of the internal EntrySet representation. More...
static Object	getValue (Map.Entry< fStringEntry, Object > pair)
	Return the value of the internal EntrySet representation. More...
static Object	getValue (Object pair, boolean convert)
	Return the value of the internal EntrySet representation. More...

Detailed Description

This class is a helper class for the nEventProperties key,value pairs.

The internal representation of the nEventProperties structure is not exposed. In order to obtain java.lang.string representations of any key or value, the values are converted by default. However, this conversion can be bypassed, by specifying false in the getKey() and getValue() methods.

The developer can then call toString on the objects returned if they are known strings, all other types are as expected, and represented normally.

Member Function Documentation

static String com.pcbsys.nirvana.client.nEventPropertiesHelper.getKey ( Object  pair )

static

Return the key element of the internal EntrySet representation.

Parameters

pair	the Entry from which to obtain the key

Returns

the key for the Entry passed

Deprecated:

Since

9.10

static String com.pcbsys.nirvana.client.nEventPropertiesHelper.getKey ( Map.Entry< fStringEntry, Object >  pair )

static

Return the key element of the internal EntrySet representation.

Parameters

pair	the Entry from which to obtain the key

Returns

the key for the Entry passed

static Object com.pcbsys.nirvana.client.nEventPropertiesHelper.getKey ( Object  pair, boolean  convert  )

static

Return the key element of the internal EntrySet representation.

Parameters

pair	the Entry from which to obtain the key
convert	if false, the internal representation of any strings will be returned, you must call toString() to obtain the java.lang.String equivilent

Returns

the key for the Entry passed

Deprecated:

Since

9.10

static Object com.pcbsys.nirvana.client.nEventPropertiesHelper.getValue ( Object  pair )

static

Return the value of the internal EntrySet representation.

Parameters

pair	the Entry from which to obtain the value

Returns

the value for the Entry passed

Deprecated:

Since

9.10

static Object com.pcbsys.nirvana.client.nEventPropertiesHelper.getValue ( Map.Entry< fStringEntry, Object >  pair )

static

Return the value of the internal EntrySet representation.

Parameters

pair	the Entry from which to obtain the value

Returns

the value for the Entry passed

static Object com.pcbsys.nirvana.client.nEventPropertiesHelper.getValue ( Object  pair, boolean  convert  )

static

Return the value of the internal EntrySet representation.

Parameters

pair	the Entry from which to obtain the key
convert	if false, the internal representation of any strings will be returned, you must call toString() to obtain the java.lang.String equivilent

Returns

the value for the Entry passed

Deprecated:

Since

9.10