com.pcbsys.nirvana.client.nChannelPublishKeys Class Reference

This class contains the information about a single channel key. More...

Public Member Functions
int	getDepth ()
	Returns the depth of the publish key.
String	getName ()
	Returns the name of the publish key.
	nChannelPublishKeys (String name, int depth) throws nIllegalArgumentException
	Constructs a publish key object to be used in the channel creation.
Protected Member Functions
	nChannelPublishKeys ()
	Public constructor.

---

Detailed Description

This class contains the information about a single channel key.

It contains the name and the depth of the key.

---

Constructor & Destructor Documentation

com.pcbsys.nirvana.client.nChannelPublishKeys.nChannelPublishKeys	(	String	name,
		int	depth
	)			throws nIllegalArgumentException

Constructs a publish key object to be used in the channel creation.

Parameters:

	name	name of the key
	depth	The number of unique values to keep in the channel

Exceptions:

nIllegalArgumentException

If the name is invalid or the depth is less then 1

---

Member Function Documentation

int com.pcbsys.nirvana.client.nChannelPublishKeys.getDepth

(

)

Returns the depth of the publish key.

Returns:

int depth

String com.pcbsys.nirvana.client.nChannelPublishKeys.getName

(

)

Returns the name of the publish key.

Returns:

String name