org.schwering.irc.lib.impl

Class DefaultIRCConfig

java.lang.Object

org.schwering.irc.lib.impl.DefaultIRCServerConfig

org.schwering.irc.lib.impl.DefaultIRCConfig

All Implemented Interfaces:

IRCConfig, IRCRuntimeConfig, IRCServerConfig

public class DefaultIRCConfig
extends DefaultIRCServerConfig
implements IRCConfig

An immutable IRCConfig. Typically created via IRCConfigBuilder.

Author:

Peter Palaga

Constructor Summary

Constructors

Constructor and Description
DefaultIRCConfig(IRCConfig config) Creates a new DefaultIRCConfig using data from the given IRCConfig.
DefaultIRCConfig(IRCServerConfig serverConfig, IRCRuntimeConfig runtimeConfig) Creates a new DefaultIRCConfig using data from the given IRCConfig.
DefaultIRCConfig(String host, int[] ports, String pass, String nick, String username, String realname, String encoding, int timeout, boolean autoPong, boolean stripColorsEnabled, IRCSSLSupport sslSupport, Proxy proxy, IRCTrafficLogger trafficLogger, IRCExceptionHandler exceptionHandler) Creates a new DefaultIRCConfig out of the individual field values.

Method Summary

Modifier and Type	Method and Description
IRCExceptionHandler	getExceptionHandler()
Proxy	getProxy()
IRCSSLSupport	getSSLSupport()
int	getTimeout()
IRCTrafficLogger	getTrafficLogger()
boolean	isAutoPong()
boolean	isStripColorsEnabled()

Methods inherited from class org.schwering.irc.lib.impl.DefaultIRCServerConfig

getEncoding, getHost, getNick, getPassword, getPortAt, getPorts, getPortsCount, getRealname, getUsername

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.schwering.irc.lib.IRCServerConfig

getEncoding, getHost, getNick, getPassword, getPortAt, getPorts, getPortsCount, getRealname, getUsername

Constructor Detail

DefaultIRCConfig

public DefaultIRCConfig(IRCConfig config)

Creates a new DefaultIRCConfig using data from the given IRCConfig.

Parameters:

config - the IRCConfig to read field values from

DefaultIRCConfig

public DefaultIRCConfig(IRCServerConfig serverConfig,
                        IRCRuntimeConfig runtimeConfig)

Creates a new DefaultIRCConfig using data from the given IRCConfig.

Parameters:

serverConfig - the IRCServerConfig to read field values from

runtimeConfig - the IRCRuntimeConfig to read field values from

DefaultIRCConfig

public DefaultIRCConfig(String host,
                        int[] ports,
                        String pass,
                        String nick,
                        String username,
                        String realname,
                        String encoding,
                        int timeout,
                        boolean autoPong,
                        boolean stripColorsEnabled,
                        IRCSSLSupport sslSupport,
                        Proxy proxy,
                        IRCTrafficLogger trafficLogger,
                        IRCExceptionHandler exceptionHandler)

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

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

timeout - the timeout

autoPong - PONG will be sent authomatically if true

stripColorsEnabled - if true color codes will be stripped

sslSupport - the IRCSSLSupport

proxy - the Proxy

trafficLogger - the IRCTrafficLogger

exceptionHandler - the IRCExceptionHandler

Method Detail

getProxy

public Proxy getProxy()

Specified by:

getProxy in interface IRCRuntimeConfig

Returns:

the Proxy to use when connecting

See Also:

IRCRuntimeConfig.getProxy()

getSSLSupport

public IRCSSLSupport getSSLSupport()

Specified by:

getSSLSupport in interface IRCRuntimeConfig

Returns:

a IRCSSLSupport if the IRCConnection should use SSL, otherwise null

See Also:

IRCRuntimeConfig.getSSLSupport()

getTimeout

public int getTimeout()

Specified by:

getTimeout in interface IRCRuntimeConfig

Returns:

the socket timeout in milliseconds

See Also:

IRCRuntimeConfig.getTimeout()

getTrafficLogger

public IRCTrafficLogger getTrafficLogger()

Specified by:

getTrafficLogger in interface IRCRuntimeConfig

Returns:

the IRCTrafficLogger that should be notified about incoming and outgoing messages or null if no traffic logger should be attached to the IRCConnection.

See Also:

IRCRuntimeConfig.getTrafficLogger()

isAutoPong

public boolean isAutoPong()

Specified by:

isAutoPong in interface IRCRuntimeConfig

Returns:

true if automatic PING? PONG! is enabled or false otherwise.

See Also:

IRCRuntimeConfig.isAutoPong()

isStripColorsEnabled

public boolean isStripColorsEnabled()

Specified by:

isStripColorsEnabled in interface IRCRuntimeConfig

Returns:

true if mIRC colorcodes should be removed from incoming IRC messages

See Also:

IRCRuntimeConfig.isStripColorsEnabled()

getExceptionHandler

public IRCExceptionHandler getExceptionHandler()

Specified by:

getExceptionHandler in interface IRCRuntimeConfig

Returns:

the IRCExceptionHandler

See Also:

IRCRuntimeConfig.getExceptionHandler()