org.xwiki.netflux

Class EntityChannel

java.lang.Object

org.xwiki.netflux.EntityChannel

@Unstable
public class EntityChannel
extends Object

A channel associated to an XWiki entity.

Since:

13.9RC1

Version:

$Id: e3a8efe3e90dc662e2c6555d5d2ec74c1ab314b2 $

Constructor Summary

Constructors

Constructor and Description
EntityChannel(org.xwiki.model.reference.EntityReference entityReference, List<String> path, String key) Creates a new channel.

Method Summary

Modifier and Type	Method and Description
org.xwiki.model.reference.EntityReference	getEntityReference()
String	getKey()
List<String>	getPath()
int	getUserCount()
void	setUserCount(int userCount) Sets the number of users connected to the channel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EntityChannel

public EntityChannel(org.xwiki.model.reference.EntityReference entityReference,
                     List<String> path,
                     String key)

Creates a new channel.

Parameters:

entityReference - the entity this channel is associated with

path - the channel path, used to identify the channel among all the channels associated to the same entity

key - the channel key

Method Detail

getEntityReference

public org.xwiki.model.reference.EntityReference getEntityReference()

Returns:

the entity associated with this channel

getPath

public List<String> getPath()

Returns:

the channel path, used to identify the channel among all the channels associated to the same entity

getKey

public String getKey()

Returns:

the channel key

getUserCount

public int getUserCount()

Returns:

the number of users connected to the channel

setUserCount

public void setUserCount(int userCount)

Sets the number of users connected to the channel.

Parameters:

userCount - the new user count