org.schwering.irc.lib.impl

Class DefaultIRCRuntimeConfig

java.lang.Object

org.schwering.irc.lib.impl.DefaultIRCRuntimeConfig

All Implemented Interfaces:

IRCRuntimeConfig

public class DefaultIRCRuntimeConfig
extends Object
implements IRCRuntimeConfig

An immutable IRCRuntimeConfig. Typically created via IRCConfigBuilder.

Author:

Peter Palaga

Constructor Summary

Constructors

Constructor and Description
DefaultIRCRuntimeConfig(int timeout, boolean autoPong, boolean stripColorsEnabled, IRCSSLSupport sslSupport, Proxy proxy, IRCTrafficLogger trafficLogger, IRCExceptionHandler exceptionHandler) Creates a new DefaultIRCRuntimeConfig out of the individual field values.
DefaultIRCRuntimeConfig(IRCRuntimeConfig runtimeConfig) Creates a new DefaultIRCRuntimeConfig using data from the given IRCRuntimeConfig.

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 java.lang.Object

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

Constructor Detail

DefaultIRCRuntimeConfig

public DefaultIRCRuntimeConfig(int timeout,
                               boolean autoPong,
                               boolean stripColorsEnabled,
                               IRCSSLSupport sslSupport,
                               Proxy proxy,
                               IRCTrafficLogger trafficLogger,
                               IRCExceptionHandler exceptionHandler)

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

Parameters:

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

DefaultIRCRuntimeConfig

public DefaultIRCRuntimeConfig(IRCRuntimeConfig runtimeConfig)

Creates a new DefaultIRCRuntimeConfig using data from the given IRCRuntimeConfig.

Parameters:

runtimeConfig - the IRCRuntimeConfig to read field values from

Method Detail

getExceptionHandler

public IRCExceptionHandler getExceptionHandler()

Specified by:

getExceptionHandler in interface IRCRuntimeConfig

Returns:

the IRCExceptionHandler

See Also:

IRCRuntimeConfig.getExceptionHandler()

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()