org.schwering.irc.lib.impl

Class DefaultIRCServerConfig

java.lang.Object

org.schwering.irc.lib.impl.DefaultIRCServerConfig

All Implemented Interfaces:

IRCServerConfig

Direct Known Subclasses:

DefaultIRCConfig

public class DefaultIRCServerConfig
extends Object
implements IRCServerConfig

An immutable IRCServerConfig. Typically created via IRCConfigBuilder.

Author:

Peter Palaga

Constructor Summary

Constructors

Constructor and Description
DefaultIRCServerConfig(IRCServerConfig serverConfig) Creates a new DefaultIRCServerConfig using data from the given IRCServerConfig.
DefaultIRCServerConfig(String host, int[] ports, String pass, String nick, String username, String realname, String encoding) Creates a new DefaultIRCServerConfig out of the individual field values.

Method Summary

Modifier and Type	Method and Description
String	getEncoding()
String	getHost()
String	getNick()
String	getPassword()
int	getPortAt(int index)
int[]	getPorts()
int	getPortsCount()
String	getRealname()
String	getUsername()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultIRCServerConfig

public DefaultIRCServerConfig(IRCServerConfig serverConfig)

Creates a new DefaultIRCServerConfig using data from the given IRCServerConfig.

Parameters:

serverConfig - the IRCServerConfig to read field values from

DefaultIRCServerConfig

public DefaultIRCServerConfig(String host,
                              int[] ports,
                              String pass,
                              String nick,
                              String username,
                              String realname,
                              String encoding)

Creates a new DefaultIRCServerConfig out of the individual field values. For meanings of the parameters, see the the respective getter methods in IRCServerConfig.

Parameters:

host - the host name or IP address

ports - the ports to try on host

pass - the password

nick - the preferred nick name

username - the username

realname - the real name

encoding - the encoding

Method Detail

getEncoding

public String getEncoding()

Specified by:

getEncoding in interface IRCServerConfig

Returns:

the encoding to use when reading and writing IRC messages

See Also:

IRCServerConfig.getEncoding()

getHost

public String getHost()

Specified by:

getHost in interface IRCServerConfig

Returns:

hostname or IP address of the IRC server to connect to

See Also:

IRCServerConfig.getHost()

getNick

public String getNick()

Specified by:

getNick in interface IRCServerConfig

Returns:

the preffered nick for the connection

See Also:

IRCServerConfig.getNick()

getPassword

public String getPassword()

Specified by:

getPassword in interface IRCServerConfig

Returns:

the password to connect with

See Also:

IRCServerConfig.getPassword()

getPortAt

public int getPortAt(int index)

Specified by:

getPortAt in interface IRCServerConfig

Parameters:

index - the intex in the internal ports array

Returns:

the port number at position index in the internal ports array

See Also:

IRCServerConfig.getPortAt(int)

getPorts

public int[] getPorts()

Specified by:

getPorts in interface IRCServerConfig

Returns:

a copy of internal ports array

See Also:

IRCServerConfig.getPorts()

getPortsCount

public int getPortsCount()

Specified by:

getPortsCount in interface IRCServerConfig

Returns:

the number of ports in the internal ports array

See Also:

IRCServerConfig.getPortsCount()

getRealname

public String getRealname()

Specified by:

getRealname in interface IRCServerConfig

Returns:

the real name of the user that is connecting

See Also:

IRCServerConfig.getRealname()

getUsername

public String getUsername()

Specified by:

getUsername in interface IRCServerConfig

Returns:

the username to connect with

See Also:

IRCServerConfig.getUsername()