net.jetrix.config
Class ChannelConfig

java.lang.Object
  net.jetrix.config.ChannelConfig

public class ChannelConfig
extends Object

Channel configuration.

Version:

$Revision: 501 $, $Date: 2004-12-14 03:24:44 +0100 (mar., 14 déc. 2004) $

Author:

Emmanuel Bourg

Field Summary

static int	PLAYER_CAPACITY Default player capacity
static int	SPECTATOR_CAPACITY Default spectator capacity

Constructor Summary

ChannelConfig()

Method Summary

void	addFilter(FilterConfig fconf) Registers a new filter.
int	getAccessLevel() Gets the minimum access level required to join the channel.
String	getDescription() Gets channel description.
Iterator<FilterConfig>	getFilters() Returns an iterator of registered filters.
int	getMaxPlayers() Gets maximum number of players allowed.
int	getMaxSpectators() Gets maximum number of spectators allowed.
String	getName() Gets channel name.
String	getPassword() Gets the password.
String	getProperty(String name)
Settings	getSettings() Gets game parameters.
String	getTopic() Return the topic.
String	getWinlistId()
boolean	isIdleAllowed()
boolean	isPasswordProtected() Tell if a password is required to enter the channel.
boolean	isPersistent() Tell if the channel will vanish once the last player leave
void	setAccessLevel(int accessLevel) Sets the minimum access level required to join the channel.
void	setDescription(String description) Sets the description shown on entering the channel.
void	setIdleAllowed(boolean idleAllowed)
void	setMaxPlayers(int maxPlayers) Sets the maximum number of players allowed at the same time in the channel.
void	setMaxSpectators(int maxSpectators) Sets the maximum number of spectators allowed at the same time in the channel.
void	setName(String name) Sets channel name.
void	setPassword(String password) Sets the password to enter the channel.
void	setPersistent(boolean persistent) Sets channel persistence
void	setProperty(String name, String value)
void	setSettings(Settings settings) Sets game parameters.
void	setTopic(String topic) Set the topic.
void	setWinlistId(String winlistId)

Methods inherited from class java.lang.Object

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

Field Detail

SPECTATOR_CAPACITY

public static final int SPECTATOR_CAPACITY

Default spectator capacity

See Also:

Constant Field Values

PLAYER_CAPACITY

public static final int PLAYER_CAPACITY

Default player capacity

See Also:

Constant Field Values

Constructor Detail

ChannelConfig

public ChannelConfig()

Method Detail

getSettings

public Settings getSettings()

Gets game parameters.

setSettings

public void setSettings(Settings settings)

Sets game parameters.

Parameters:

settings -

getName

public String getName()

Gets channel name.

setName

public void setName(String name)

Sets channel name.

Parameters:

name -

getPassword

public String getPassword()

Gets the password.

setPassword

public void setPassword(String password)

Sets the password to enter the channel.

getDescription

public String getDescription()

Gets channel description.

setDescription

public void setDescription(String description)

Sets the description shown on entering the channel.

getTopic

public String getTopic()

Return the topic.

setTopic

public void setTopic(String topic)

Set the topic.

getMaxPlayers

public int getMaxPlayers()

Gets maximum number of players allowed.

setMaxPlayers

public void setMaxPlayers(int maxPlayers)

Sets the maximum number of players allowed at the same time in the channel.

Parameters:

maxPlayers -

getMaxSpectators

public int getMaxSpectators()

Gets maximum number of spectators allowed.

setMaxSpectators

public void setMaxSpectators(int maxSpectators)

Sets the maximum number of spectators allowed at the same time in the channel.

Parameters:

maxSpectators -

getAccessLevel

public int getAccessLevel()

Gets the minimum access level required to join the channel.

setAccessLevel

public void setAccessLevel(int accessLevel)

Sets the minimum access level required to join the channel.

Parameters:

accessLevel -

isPersistent

public boolean isPersistent()

Tell if the channel will vanish once the last player leave

Returns:

true if the channel is persistent, false if not

setPersistent

public void setPersistent(boolean persistent)

Sets channel persistence

Parameters:

persistent -

getWinlistId

public String getWinlistId()

setWinlistId

public void setWinlistId(String winlistId)

getProperty

public String getProperty(String name)

setProperty

public void setProperty(String name,
                        String value)

isPasswordProtected

public boolean isPasswordProtected()

Tell if a password is required to enter the channel.

getFilters

public Iterator<FilterConfig> getFilters()

Returns an iterator of registered filters.

addFilter

public void addFilter(FilterConfig fconf)

Registers a new filter.

isIdleAllowed

public boolean isIdleAllowed()

setIdleAllowed

public void setIdleAllowed(boolean idleAllowed)