IRCConfigBuilder (IRClib 2.0.0.Alpha3 API)

java.lang.Object
- org.schwering.irc.lib.IRCConfigBuilder

```
public final class IRCConfigBuilder
extends Object
```
A fluent builder for IRCConfigs. For the typical usage, see IRCConnection.

Author:

Peter Palaga

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_AUTOPONG` Default `autoPong` is
`static String`	`DEFAULT_ENCODING` Default `encoding` is
`static boolean`	`DEFAULT_STRIP_COLORS` Default `stripColors` is
`static int`	`DEFAULT_TIMEOUT` Default `timeout` is milliseconds which is 15 minutes

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IRCConfigBuilder`	`autoPong(boolean autoPong)` Enables or disables the automatic PING? PONG! support.
`IRCConfig`	`build()`
`IRCConfigBuilder`	`config(IRCConfig config)` Copies all available fields from the given `config` to this `IRCConfigBuilder`.
`IRCConfigBuilder`	`encoding(String encoding)` Changes the character encoding (such as `"UTF-8"` or `"ISO-8859-1"`) used to talk to the server.
`IRCConfigBuilder`	`exceptionHandler(IRCExceptionHandler exceptionHandler)` Sets the `IRCExceptionHandler` that should be notified by `IRCConnection` when an exception during send or receive of IRC messages occurs.
`IRCConfigBuilder`	`host(String host)` Sets the hostname or IP address of the IRC server to connect to.
`static IRCConfigBuilder`	`newBuilder()` Creates a new `IRCConfigBuilder` initializing the following fields with defaults: `autoPong(boolean)` `encoding(String)` `stripColors(boolean)` `timeout(int)` Other fields are left `null`.
`IRCConfigBuilder`	`nick(String nick)` Sets the nick name preferred by the user who is connecting.
`IRCConfigBuilder`	`password(String password)` Sets the password of the user who is connecting.
`IRCConfigBuilder`	`port(int port)` Adds the given `port` to the internal list of ports.
`IRCConfigBuilder`	`portRange(int portMin, int portMax)` Adds the port numbers from the given range to the internal list of ports.
`IRCConfigBuilder`	`ports(int... port)` Adds the given port numbers to the internal list of ports.
`IRCConfigBuilder`	`realname(String realname)` Sets the real name (e.g.
`IRCConfigBuilder`	`runtimeConfig(IRCRuntimeConfig runtimeConfig)` Copies all available fields from the given `runtimeConfig` to this `IRCConfigBuilder`.
`IRCConfigBuilder`	`serverConfig(IRCServerConfig serverConfig)` Copies all available fields from the given `serverConfig` to this `IRCConfigBuilder`.
`IRCConfigBuilder`	`socksProxy(String socksProxyHost, int socksProxyPort)` Instructs the connection to use a SOCKS proxy with given `host` and `port`.
`IRCConfigBuilder`	`sslSupport(IRCSSLSupport sslSupport)` Sets the `IRCSSLSupport` containing the information the `IRCConnection` should use to connect using SSL.
`IRCConfigBuilder`	`stripColors(boolean stripColors)` Enables or disables the stripping of mIRC color codes.
`IRCConfigBuilder`	`timeout(int millis)` Sets the preferred connection's timeout in milliseconds.
`IRCConfigBuilder`	`trafficLogger(IRCTrafficLogger trafficLogger)` Sets the `IRCTrafficLogger` that should be notified by `IRCConnection` about incoming and outgoing messages.
`IRCConfigBuilder`	`username(String username)` Sets the username of the user connecting to the IRC server.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_AUTOPONG
```
public static final boolean DEFAULT_AUTOPONG
```
    Default autoPong is
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ENCODING
```
public static final String DEFAULT_ENCODING
```
    Default encoding is
    
    See Also:
    
    Constant Field Values
  - DEFAULT_STRIP_COLORS
```
public static final boolean DEFAULT_STRIP_COLORS
```
    Default stripColors is
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TIMEOUT
```
public static final int DEFAULT_TIMEOUT
```
    Default timeout is milliseconds which is 15 minutes
    
    See Also:
    
    Constant Field Values
- Method Detail
  - newBuilder
```
public static IRCConfigBuilder newBuilder()
```
    Creates a new IRCConfigBuilder initializing the following fields with defaults:
    Other fields are left null.
    Returns:
    
    new IRCConfigBuilder
  - autoPong
```
public IRCConfigBuilder autoPong(boolean autoPong)
```
    Enables or disables the automatic PING? PONG! support. If not set through this method, the default is true.
    
    Parameters:
    
    autoPong - true to enable automatic PONG reply, false makes the class fire onPing events.
    
    Returns:
    
    this builder
  - build
```
public IRCConfig build()
```
    Returns:
    
    a new DefaultIRCConfig instance based on the values stored in fields of this IRCConfigBuilder.
  - config
```
public IRCConfigBuilder config(IRCConfig config)
```
    Copies all available fields from the given config to this IRCConfigBuilder.
    
    Parameters:
    
    config - the IRCConfig to take the values from
    
    Returns:
    
    this builder
  - encoding
```
public IRCConfigBuilder encoding(String encoding)
```
    Changes the character encoding (such as "UTF-8" or "ISO-8859-1") used to talk to the server. If not set through this method, the default is "utf-8".
    
    Parameters:
    
    encoding - The new encoding string, e.g. "UTF-8"
    
    Returns:
    
    this builder
  - exceptionHandler
```
public IRCConfigBuilder exceptionHandler(IRCExceptionHandler exceptionHandler)
```
    Sets the IRCExceptionHandler that should be notified by IRCConnection when an exception during send or receive of IRC messages occurs.
    
    Parameters:
    
    exceptionHandler - the IRCExceptionHandler
    
    Returns:
    
    this builder
  - host
```
public IRCConfigBuilder host(String host)
```
    Sets the hostname or IP address of the IRC server to connect to.
    
    Parameters:
    
    host - the host name or IP address
    
    Returns:
    
    this builder
  - nick
```
public IRCConfigBuilder nick(String nick)
```
    Sets the nick name preferred by the user who is connecting.
    
    Parameters:
    
    nick - the nick name
    
    Returns:
    
    this builder
  - password
```
public IRCConfigBuilder password(String password)
```
    Sets the password of the user who is connecting.
    
    Parameters:
    
    password - the password
    
    Returns:
    
    this builder
  - port
```
public IRCConfigBuilder port(int port)
```
    Adds the given port to the internal list of ports.
    
    Parameters:
    
    port - the port or the host(String) to connect to
    
    Returns:
    
    this builder
  - portRange
```
public IRCConfigBuilder portRange(int portMin,
                                  int portMax)
```
    Adds the port numbers from the given range to the internal list of ports. portMin is the first (lowest) port to add whereas portMax is the last port to add.
    
    Parameters:
    
    portMin - The beginning port of the port range.
    
    portMax - The ending port of the port range.
    
    Returns:
    
    this builder
  - ports
```
public IRCConfigBuilder ports(int... port)
```
    Adds the given port numbers to the internal list of ports.
    
    Parameters:
    
    port - the port numbers to add
    
    Returns:
    
    this builder
  - realname
```
public IRCConfigBuilder realname(String realname)
```
    Sets the real name (e.g. ) of the user who is connecting.
    
    Parameters:
    
    realname - the real name
    
    Returns:
    
    this builder
  - runtimeConfig
```
public IRCConfigBuilder runtimeConfig(IRCRuntimeConfig runtimeConfig)
```
    Copies all available fields from the given runtimeConfig to this IRCConfigBuilder.
    
    Parameters:
    
    runtimeConfig - the IRCRuntimeConfig to take the values from
    
    Returns:
    
    this builder
  - serverConfig
```
public IRCConfigBuilder serverConfig(IRCServerConfig serverConfig)
```
    Copies all available fields from the given serverConfig to this IRCConfigBuilder.
    
    Parameters:
    
    serverConfig - the IRCServerConfig to take the values from
    
    Returns:
    
    this builder
  - socksProxy
```
public IRCConfigBuilder socksProxy(String socksProxyHost,
                                   int socksProxyPort)
```
    Instructs the connection to use a SOCKS proxy with given host and port.
    
    Parameters:
    
    socksProxyHost - the hostname or IP address of the SOCKS proxy
    
    socksProxyPort - the port of the SOCKS proxy
    
    Returns:
    
    this builder
  - sslSupport
```
public IRCConfigBuilder sslSupport(IRCSSLSupport sslSupport)
```
    Sets the IRCSSLSupport containing the information the IRCConnection should use to connect using SSL.
    
    Parameters:
    
    sslSupport - the username of the user connecting to the IRC server
    
    Returns:
    
    this builder
  - stripColors
```
public IRCConfigBuilder stripColors(boolean stripColors)
```
    Enables or disables the stripping of mIRC color codes. If not set through this method, the default is false.
    
    Parameters:
    
    stripColors - true to enable, false to disable colors
    
    Returns:
    
    this builder
  - timeout
```
public IRCConfigBuilder timeout(int millis)
```
    Sets the preferred connection's timeout in milliseconds. If not set through this method, the default is 900000.
    
    Parameters:
    
    millis - The socket's timeout in milliseconds.
    
    Returns:
    
    this builder
  - trafficLogger
```
public IRCConfigBuilder trafficLogger(IRCTrafficLogger trafficLogger)
```
    Sets the IRCTrafficLogger that should be notified by IRCConnection about incoming and outgoing messages.
    
    Parameters:
    
    trafficLogger - the IRCTrafficLogger the connection should notify
    
    Returns:
    
    this builder
  - username
```
public IRCConfigBuilder username(String username)
```
    Sets the username of the user connecting to the IRC server.
    
    Parameters:
    
    username - the username of the user connecting to the IRC server
    
    Returns:
    
    this builder

Class IRCConfigBuilder

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_AUTOPONG

DEFAULT_ENCODING

DEFAULT_STRIP_COLORS

DEFAULT_TIMEOUT

Method Detail

newBuilder

autoPong

build

config

encoding

exceptionHandler

host

nick

password

port

portRange

ports

realname

runtimeConfig

serverConfig

socksProxy

sslSupport

stripColors

timeout

trafficLogger

username