Configuration.Builder (pircbotx 2.2 API)

java.lang.Object
- org.pircbotx.Configuration.Builder

Enclosing class:

Configuration
```
public static class Configuration.Builder
extends Object
```
Builder to create an immutable Configuration.

Constructor Summary

Constructors
Constructor and Description
`Builder()` Create with defaults that work in most situations and IRC servers
`Builder(Configuration.Builder otherBuilder)` Copy values from another builder.
`Builder(Configuration configuration)` Copy values from an existing Configuration.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Configuration.Builder`	`addAutoJoinChannel(String channel)` Add a channel to join on connect
`Configuration.Builder`	`addAutoJoinChannel(String channel, String key)` Utility method for `getAutoJoinChannels().put(channel, key)`
`Configuration.Builder`	`addAutoJoinChannels(Iterable<String> channels)`
`Configuration.Builder`	`addCapHandler(CapHandler handler)` Add a cap handler
`Configuration.Builder`	`addCapHandlers(Iterable<CapHandler> handlers)` Add a collection of cap handlers
`Configuration.Builder`	`addListener(Listener listener)` Add a listener to the current ListenerManager
`Configuration.Builder`	`addListeners(Iterable<Listener> listeners)` Add a collection of listeners to the current ListenerManager
`Configuration.Builder`	`addServer(Configuration.ServerEntry serverEntry)`
`Configuration.Builder`	`addServer(String server)`
`Configuration.Builder`	`addServer(String server, int port)`
`Configuration.Builder`	`addServers(Iterable<Configuration.ServerEntry> serverEnteries)`
`Configuration`	`buildConfiguration()` Builds a Configuration instance from the information in this builder
`Configuration`	`buildForServer(String hostname)` Create a new builder with the specified hostname then build a configuration.
`Configuration`	`buildForServer(String hostname, int port)` Create a new builder with the specified hostname and port then build a configuration.
`Configuration`	`buildForServer(String hostname, int port, String password)` Create a new builder with the specified hostname, port, and password then build a configuration.
`boolean`	`equals(Object o)`
`Map<String,String>`	`getAutoJoinChannels()` Map of channels and keys to automatically join upon connecting.
`int`	`getAutoReconnectAttempts()` Number of times to attempt to reconnect, default 5.
`Delay`	`getAutoReconnectDelay()` Delay in milliseconds between reconnect attempts, default 0.
`Configuration.BotFactory`	`getBotFactory()` The `Configuration.BotFactory` to use
`List<CapHandler>`	`getCapHandlers()` IRCv3 CAP features to try to use, default enables multi-prefix and away-notify but ignoring if the server doesn't support them
`List<ChannelModeHandler>`	`getChannelModeHandlers()` Handlers for channel modes, defaults to built-in handlers which cover basic modes that are generally supported on most IRC servers
`String`	`getChannelPrefixes()` Allowed channel prefix characters, default `#&+!`
`int`	`getDccAcceptTimeout()` Timeout for user to accept a sent DCC request.
`InetAddress`	`getDccLocalAddress()` The local address to bind DCC connections to, defaults to null (which will be figured out at runtime)
`List<Integer>`	`getDccPorts()` Ports to allow DCC incoming connections, recommended to set multiple as DCC connections will be rejected if no free port can be found
`InetAddress`	`getDccPublicAddress()` The public address advertised to other users, defaults to null (which will be figured out at runtime)
`int`	`getDccResumeAcceptTimeout()` Timeout for a user to accept a resumed DCC request.
`int`	`getDccTransferBufferSize()` Size of the DCC file transfer buffer, default 1024 bytes
`Charset`	`getEncoding()` Charset encoding to use for connection, defaults to `Charset.defaultCharset()`
`String`	`getFinger()` CTCP finger response
`<M extends ListenerManager> M`	`getListenerManager()` Returns the current ListenerManager in use by this bot.
`InetAddress`	`getLocalAddress()` Address to bind to when connecting to IRC server, default null
`Locale`	`getLocale()` Locale to use for connection, defaults to `Locale.getDefault()`
`String`	`getLogin()` The login to be used for the IRC connection (nick!login@host), default PircBotX
`int`	`getMaxLineLength()` Maximum line length of IRC server, defaults 512 characters
`Delay`	`getMessageDelay()` Millisecond delay between sending messages, default 1000 milliseconds
`String`	`getName()` The nick to be used for the IRC connection (nick!login@host), must not be blank
`String`	`getNickservCustomMessage()` Some irc servers require a custom identify string.
`String`	`getNickservNick()` The nick of the nickserv service account, default "nickserv".
`String`	`getNickservOnSuccess()` Case-insensitive message a user with `setNickservNick(java.lang.String)` in its hostmask will always contain when we have successfully identified, defaults to "you are now" which which matches all of the following known server responses: ircd-seven (freenode) - You are now identified for PircBotX Unreal (swiftirc) - Password accepted - you are now recognized. InspIRCd (mozilla) - You are now logged in as PircBotX
`String`	`getNickservPassword()` Password to authenticate against NICKSERV, default null (will not try to identify)
`String`	`getRealName()` The realName/fullname used for WHOIS info, defaults to version
`String`	`getServerPassword()` Password for IRC server, default null
`List<Configuration.ServerEntry>`	`getServers()` List of servers to connect to, easily add with the addServer methods
`int`	`getSocketConnectTimeout()`
`SocketFactory`	`getSocketFactory()` Socket factory for connections, defaults to `SocketFactory.getDefault()`
`int`	`getSocketTimeout()` Milliseconds to wait with no data from the IRC server before sending a PING request to check if the socket is still alive, default 5 minutes (1000x60x5=300,000 milliseconds)
`String`	`getUserLevelPrefixes()` Supported channel prefixes that restrict a sent message to users with this mode, eg `PRIVMSG +#channel :hello` will only send a message to voiced or higher users, default `+@%&~!`
`String`	`getVersion()` CTCP version response.
`InetAddress`	`getWebIrcAddress()` IP address of WEBIRC connection, must be set if WEBIRC is enabled
`String`	`getWebIrcHostname()` Hostname of WEBIRC connection, must not be blank if WEBIRC is enabled
`String`	`getWebIrcPassword()` Password of WEBIRC connection, must not be blank if WEBIRC is enabled
`String`	`getWebIrcUsername()` Username of WEBIRC connection, must not be blank if WEBIRC is enabled
`int`	`hashCode()`
`boolean`	`isAutoNickChange()` Enable or disable automatic nick changing if a nick is in use by adding a number to the end, default false which will throw a `IrcException` if the nick is already in use on the server
`boolean`	`isAutoReconnect()` Enable or disable automatic reconnecting, default false.
`boolean`	`isAutoSplitMessage()` Enable or disable automatic message splitting to fit `getMaxLineLength()` to prevent the IRC server from possibly truncating or rejecting the line, default true.
`boolean`	`isCapEnabled()` Enable or disable CAP handling, defaults true.
`boolean`	`isDccFilenameQuotes()` If true sends filenames in quotes, otherwise uses underscores, default enabled.
`boolean`	`isDccPassiveRequest()` Send DCC requests as passive/reverse requests if not specified otherwise, default false
`boolean`	`isIdentServerEnabled()` Enable or disable use of an existing `IdentServer`, default false.
`boolean`	`isNickservDelayJoin()` Delay joining channels until were identified to nickserv, default false
`boolean`	`isOnJoinWhoEnabled()` Enable or disable sending "WHO #channel" upon joining a channel and rely only on the NAMES response
`boolean`	`isShutdownHookEnabled()` Enable or disable creating a JVM shutdown hook which will properly QUIT the IRC server and shutdown the bot, default true
`boolean`	`isSnapshotsEnabled()` Enable creation of snapshots, default true.
`boolean`	`isUserModeHideRealHost()` Sets mode +x on the bot, to hide the real hostname, default = false
`boolean`	`isWebIrcEnabled()` Enable or disable sending WEBIRC line on connect, default disabled
`void`	`replaceCoreHooksListener(CoreHooks extended)`
`Configuration.Builder`	`setAutoNickChange(boolean autoNickChange)` Enable or disable automatic nick changing if a nick is in use by adding a number to the end, default false which will throw a `IrcException` if the nick is already in use on the server
`Configuration.Builder`	`setAutoReconnect(boolean autoReconnect)` Enable or disable automatic reconnecting, default false.
`Configuration.Builder`	`setAutoReconnectAttempts(int autoReconnectAttempts)` Number of times to attempt to reconnect, default 5.
`Configuration.Builder`	`setAutoReconnectDelay(Delay autoReconnectDelay)` Delay in milliseconds between reconnect attempts, default 0.
`Configuration.Builder`	`setAutoSplitMessage(boolean autoSplitMessage)` Enable or disable automatic message splitting to fit `getMaxLineLength()` to prevent the IRC server from possibly truncating or rejecting the line, default true.
`Configuration.Builder`	`setBotFactory(Configuration.BotFactory botFactory)` The `Configuration.BotFactory` to use
`Configuration.Builder`	`setCapEnabled(boolean capEnabled)` Enable or disable CAP handling, defaults true.
`Configuration.Builder`	`setChannelPrefixes(String channelPrefixes)` Allowed channel prefix characters, default `#&+!`
`Configuration.Builder`	`setDccAcceptTimeout(int dccAcceptTimeout)` Timeout for user to accept a sent DCC request, defaults to `getSocketTimeout()`
`Configuration.Builder`	`setDccFilenameQuotes(boolean dccFilenameQuotes)` If true sends filenames in quotes, otherwise uses underscores, default enabled.
`Configuration.Builder`	`setDccLocalAddress(InetAddress dccLocalAddress)` The local address to bind DCC connections to, defaults to null (which will be figured out at runtime)
`Configuration.Builder`	`setDccPassiveRequest(boolean dccPassiveRequest)` Send DCC requests as passive/reverse requests if not specified otherwise, default false
`Configuration.Builder`	`setDccPorts(List<Integer> dccPorts)` Ports to allow DCC incoming connections, recommended to set multiple as DCC connections will be rejected if no free port can be found
`Configuration.Builder`	`setDccPublicAddress(InetAddress dccPublicAddress)` The public address advertised to other users, defaults to null (which will be figured out at runtime)
`Configuration.Builder`	`setDccResumeAcceptTimeout(int dccResumeAcceptTimeout)` Timeout for a user to accept a resumed DCC request, defaults to `getDccResumeAcceptTimeout()`
`Configuration.Builder`	`setDccTransferBufferSize(int dccTransferBufferSize)` Size of the DCC file transfer buffer, default 1024 bytes
`Configuration.Builder`	`setEncoding(Charset encoding)` Charset encoding to use for connection, defaults to `Charset.defaultCharset()`
`Configuration.Builder`	`setFinger(String finger)` CTCP finger response
`Configuration.Builder`	`setIdentServerEnabled(boolean identServerEnabled)` Enable or disable use of an existing `IdentServer`, default false.
`Configuration.Builder`	`setListenerManager(ListenerManager listenerManager)` Sets a new ListenerManager.
`Configuration.Builder`	`setLocalAddress(InetAddress localAddress)` Address to bind to when connecting to IRC server, default null
`Configuration.Builder`	`setLocale(Locale locale)` Locale to use for connection, defaults to `Locale.getDefault()`
`Configuration.Builder`	`setLogin(String login)` The login to be used for the IRC connection (nick!login@host), default PircBotX
`Configuration.Builder`	`setMaxLineLength(int maxLineLength)` Maximum line length of IRC server, defaults 512 characters
`Configuration.Builder`	`setMessageDelay(Delay messageDelay)` Millisecond delay between sending messages, default 1000 milliseconds
`Configuration.Builder`	`setName(String name)` The nick to be used for the IRC connection (nick!login@host), must not be blank
`Configuration.Builder`	`setNickservCustomMessage(String nickservCustomMessage)` Some irc servers require a custom identify string.
`Configuration.Builder`	`setNickservDelayJoin(boolean nickservDelayJoin)` Delay joining channels until were identified to nickserv, default false
`Configuration.Builder`	`setNickservNick(String nickservNick)` The nick of the nickserv service account, default "nickserv".
`Configuration.Builder`	`setNickservOnSuccess(String nickservOnSuccess)` Case-insensitive message a user with `setNickservNick(java.lang.String)` in its hostmask will always contain when we have successfully identified, defaults to "you are now" which which matches all of the following known server responses: ircd-seven (freenode) - You are now identified for PircBotX Unreal (swiftirc) - Password accepted - you are now recognized. InspIRCd (mozilla) - You are now logged in as PircBotX
`Configuration.Builder`	`setNickservPassword(String nickservPassword)` Password to authenticate against NICKSERV, default null (will not try to identify)
`Configuration.Builder`	`setOnJoinWhoEnabled(boolean onJoinWhoEnabled)` Enable or disable sending "WHO #channel" upon joining a channel and rely only on the NAMES response
`Configuration.Builder`	`setRealName(String realName)` The realName/fullname used for WHOIS info, defaults to version
`Configuration.Builder`	`setServer(String hostname)` Deprecated. Use `addServer(java.lang.String)`, will be removed in future releases
`Configuration.Builder`	`setServer(String hostname, int port)` Deprecated. Use `addServer(java.lang.String, int)`, will be removed in future releases
`Configuration.Builder`	`setServerHostname(String hostname)` Deprecated. Use `addServer(java.lang.String)`, will be removed in future releases
`Configuration.Builder`	`setServerPassword(String serverPassword)` Password for IRC server, default null
`Configuration.Builder`	`setServerPort(int port)` Deprecated. Use `addServer(java.lang.String, int)`, will be removed in future releases
`Configuration.Builder`	`setServers(List<Configuration.ServerEntry> servers)` List of servers to connect to, easily add with the addServer methods
`Configuration.Builder`	`setShutdownHookEnabled(boolean shutdownHookEnabled)` Enable or disable creating a JVM shutdown hook which will properly QUIT the IRC server and shutdown the bot, default true
`Configuration.Builder`	`setSnapshotsEnabled(boolean snapshotsEnabled)` Enable creation of snapshots, default true.
`Configuration.Builder`	`setSocketConnectTimeout(int socketConnectTimeout)` Milliseconds to wait to connect to an IRC server address before trying the next address, default `getSocketTimeout()`
`Configuration.Builder`	`setSocketFactory(SocketFactory socketFactory)` Socket factory for connections, defaults to `SocketFactory.getDefault()`
`Configuration.Builder`	`setSocketTimeout(int socketTimeout)` Milliseconds to wait with no data from the IRC server before sending a PING request to check if the socket is still alive, default 5 minutes (1000x60x5=300,000 milliseconds)
`Configuration.Builder`	`setUserLevelPrefixes(String userLevelPrefixes)` Supported channel prefixes that restrict a sent message to users with this mode, eg `PRIVMSG +#channel :hello` will only send a message to voiced or higher users, default `+@%&~!`
`Configuration.Builder`	`setUserModeHideRealHost(boolean userModeHideRealHost)` Sets mode +x on the bot, to hide the real hostname, default = false
`Configuration.Builder`	`setVersion(String version)` CTCP version response.
`Configuration.Builder`	`setWebIrcAddress(InetAddress webIrcAddress)` IP address of WEBIRC connection, must be set if WEBIRC is enabled
`Configuration.Builder`	`setWebIrcEnabled(boolean webIrcEnabled)` Enable or disable sending WEBIRC line on connect, default disabled
`Configuration.Builder`	`setWebIrcHostname(String webIrcHostname)` Hostname of WEBIRC connection, must not be blank if WEBIRC is enabled
`Configuration.Builder`	`setWebIrcPassword(String webIrcPassword)` Password of WEBIRC connection, must not be blank if WEBIRC is enabled
`Configuration.Builder`	`setWebIrcUsername(String webIrcUsername)` Username of WEBIRC connection, must not be blank if WEBIRC is enabled
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
    Create with defaults that work in most situations and IRC servers
  - Builder
```
public Builder(Configuration configuration)
```
    Copy values from an existing Configuration.
    
    Parameters:
    
    configuration - Configuration to copy values from
  - Builder
```
public Builder(Configuration.Builder otherBuilder)
```
    Copy values from another builder.
    
    Parameters:
    
    otherBuilder -
- Method Detail
  - getSocketConnectTimeout
```
public int getSocketConnectTimeout()
```
  - getDccAcceptTimeout
```
public int getDccAcceptTimeout()
```
    Timeout for user to accept a sent DCC request. Defaults to getSocketTimeout()
  - getDccResumeAcceptTimeout
```
public int getDccResumeAcceptTimeout()
```
    Timeout for a user to accept a resumed DCC request. Defaults to getDccResumeAcceptTimeout()
  - addCapHandlers
```
public Configuration.Builder addCapHandlers(@NonNull
                                            Iterable<CapHandler> handlers)
```
    Add a collection of cap handlers
    
    Parameters:
    
    handlers -
    
    See Also:
    
    getCapHandlers()
  - addCapHandler
```
public Configuration.Builder addCapHandler(CapHandler handler)
```
    Add a cap handler
    
    Parameters:
    
    handler -
    
    See Also:
    
    getCapHandlers()
  - addListeners
```
public Configuration.Builder addListeners(@NonNull
                                          Iterable<Listener> listeners)
```
    Add a collection of listeners to the current ListenerManager
    
    Parameters:
    
    listeners -
    
    See Also:
    
    getListenerManager()
  - addListener
```
public Configuration.Builder addListener(Listener listener)
```
    Add a listener to the current ListenerManager
    
    Parameters:
    
    listener -
    
    See Also:
    
    getListenerManager()
  - addAutoJoinChannels
```
public Configuration.Builder addAutoJoinChannels(@NonNull
                                                 Iterable<String> channels)
```
  - addAutoJoinChannel
```
public Configuration.Builder addAutoJoinChannel(@NonNull
                                                String channel)
```
    Add a channel to join on connect
    
    Parameters:
    
    channel -
    
    See Also:
    
    getAutoJoinChannels()
  - addAutoJoinChannel
```
public Configuration.Builder addAutoJoinChannel(@NonNull
                                                String channel,
                                                @NonNull
                                                String key)
```
    Utility method for getAutoJoinChannels().put(channel, key)
    
    Parameters:
    
    channel -
  - setServer
```
@Deprecated
public Configuration.Builder setServer(String hostname)
```
    Deprecated. Use addServer(java.lang.String), will be removed in future releases
  - setServer
```
@Deprecated
public Configuration.Builder setServer(String hostname,
                                                   int port)
```
    Deprecated. Use addServer(java.lang.String, int), will be removed in future releases
  - setServerHostname
```
@Deprecated
public Configuration.Builder setServerHostname(String hostname)
```
    Deprecated. Use addServer(java.lang.String), will be removed in future releases
  - setServerPort
```
@Deprecated
public Configuration.Builder setServerPort(int port)
```
    Deprecated. Use addServer(java.lang.String, int), will be removed in future releases
  - addServer
```
public Configuration.Builder addServer(@NonNull
                                       String server)
```
  - addServer
```
public Configuration.Builder addServer(@NonNull
                                       String server,
                                       int port)
```
  - addServer
```
public Configuration.Builder addServer(@NonNull
                                       Configuration.ServerEntry serverEntry)
```
  - addServers
```
public Configuration.Builder addServers(@NonNull
                                        Iterable<Configuration.ServerEntry> serverEnteries)
```
  - setListenerManager
```
public Configuration.Builder setListenerManager(ListenerManager listenerManager)
```
    Sets a new ListenerManager. NOTE: The CoreHooks are added when this method is called. If you do not want this, remove CoreHooks with ListenerManager.removeListener(org.pircbotx.hooks.Listener)
    
    Parameters:
    
    listenerManager - The listener manager
  - replaceCoreHooksListener
```
public void replaceCoreHooksListener(CoreHooks extended)
```
  - getListenerManager
```
public <M extends ListenerManager> M getListenerManager()
```
    Returns the current ListenerManager in use by this bot. Note that the default listener manager (ListenerManager) is lazy loaded here unless one was already set
    
    Returns:
    
    Current ListenerManager
  - buildConfiguration
```
public Configuration buildConfiguration()
```
    Builds a Configuration instance from the information in this builder
  - buildForServer
```
public Configuration buildForServer(String hostname)
```
    Create a new builder with the specified hostname then build a configuration. Useful for template builders
    
    Parameters:
    
    hostname -
  - buildForServer
```
public Configuration buildForServer(String hostname,
                                    int port)
```
    Create a new builder with the specified hostname and port then build a configuration. Useful for template builders
    
    Parameters:
    
    hostname -
  - buildForServer
```
public Configuration buildForServer(String hostname,
                                    int port,
                                    String password)
```
    Create a new builder with the specified hostname, port, and password then build a configuration. Useful for template builders
    
    Parameters:
    
    hostname -
  - isWebIrcEnabled
```
@Generated(value="lombok")
public boolean isWebIrcEnabled()
```
    Enable or disable sending WEBIRC line on connect, default disabled
  - getWebIrcUsername
```
@Generated(value="lombok")
public String getWebIrcUsername()
```
    Username of WEBIRC connection, must not be blank if WEBIRC is enabled
  - getWebIrcHostname
```
@Generated(value="lombok")
public String getWebIrcHostname()
```
    Hostname of WEBIRC connection, must not be blank if WEBIRC is enabled
  - getWebIrcAddress
```
@Generated(value="lombok")
public InetAddress getWebIrcAddress()
```
    IP address of WEBIRC connection, must be set if WEBIRC is enabled
  - getWebIrcPassword
```
@Generated(value="lombok")
public String getWebIrcPassword()
```
    Password of WEBIRC connection, must not be blank if WEBIRC is enabled
  - getName
```
@Generated(value="lombok")
public String getName()
```
    The nick to be used for the IRC connection (nick!login@host), must not be blank
  - getLogin
```
@Generated(value="lombok")
public String getLogin()
```
    The login to be used for the IRC connection (nick!login@host), default PircBotX
  - getVersion
```
@Generated(value="lombok")
public String getVersion()
```
    CTCP version response.
  - getFinger
```
@Generated(value="lombok")
public String getFinger()
```
    CTCP finger response
  - getRealName
```
@Generated(value="lombok")
public String getRealName()
```
    The realName/fullname used for WHOIS info, defaults to version
  - getChannelPrefixes
```
@Generated(value="lombok")
public String getChannelPrefixes()
```
    Allowed channel prefix characters, default #&+!
  - getUserLevelPrefixes
```
@Generated(value="lombok")
public String getUserLevelPrefixes()
```
    Supported channel prefixes that restrict a sent message to users with this mode, eg PRIVMSG +#channel :hello will only send a message to voiced or higher users, default +@%&~!
  - isSnapshotsEnabled
```
@Generated(value="lombok")
public boolean isSnapshotsEnabled()
```
    Enable creation of snapshots, default true. In bulk datasets or very lower power devices, creating snapshots can be a relatively expensive operation for every GenericSnapshotEvent (eg PartEvent, QuitEvent) since the entire UserChannelDao with all of its users and channels is cloned. This can optionally disabled by setting this to false, however this makes all GenericSnapshotEvent.getUserChannelDaoSnapshot() calls return null.
    In regular usage disabling snapshots is not necessary because there relatively few user QUITs and PARTs per second.
  - isDccFilenameQuotes
```
@Generated(value="lombok")
public boolean isDccFilenameQuotes()
```
    If true sends filenames in quotes, otherwise uses underscores, default enabled.
  - getDccPorts
```
@Generated(value="lombok")
public List<Integer> getDccPorts()
```
    Ports to allow DCC incoming connections, recommended to set multiple as DCC connections will be rejected if no free port can be found
  - getDccLocalAddress
```
@Generated(value="lombok")
public InetAddress getDccLocalAddress()
```
    The local address to bind DCC connections to, defaults to null (which will be figured out at runtime)
  - getDccPublicAddress
```
@Generated(value="lombok")
public InetAddress getDccPublicAddress()
```
    The public address advertised to other users, defaults to null (which will be figured out at runtime)
  - getDccTransferBufferSize
```
@Generated(value="lombok")
public int getDccTransferBufferSize()
```
    Size of the DCC file transfer buffer, default 1024 bytes
  - isDccPassiveRequest
```
@Generated(value="lombok")
public boolean isDccPassiveRequest()
```
    Send DCC requests as passive/reverse requests if not specified otherwise, default false
  - getServers
```
@Generated(value="lombok")
public List<Configuration.ServerEntry> getServers()
```
    List of servers to connect to, easily add with the addServer methods
  - getServerPassword
```
@Generated(value="lombok")
public String getServerPassword()
```
    Password for IRC server, default null
  - getSocketFactory
```
@Generated(value="lombok")
public SocketFactory getSocketFactory()
```
    Socket factory for connections, defaults to SocketFactory.getDefault()
  - getLocalAddress
```
@Generated(value="lombok")
public InetAddress getLocalAddress()
```
    Address to bind to when connecting to IRC server, default null
  - getEncoding
```
@Generated(value="lombok")
public Charset getEncoding()
```
    Charset encoding to use for connection, defaults to Charset.defaultCharset()
  - getLocale
```
@Generated(value="lombok")
public Locale getLocale()
```
    Locale to use for connection, defaults to Locale.getDefault()
  - getSocketTimeout
```
@Generated(value="lombok")
public int getSocketTimeout()
```
    Milliseconds to wait with no data from the IRC server before sending a PING request to check if the socket is still alive, default 5 minutes (1000x60x5=300,000 milliseconds)
  - getMaxLineLength
```
@Generated(value="lombok")
public int getMaxLineLength()
```
    Maximum line length of IRC server, defaults 512 characters
  - isAutoSplitMessage
```
@Generated(value="lombok")
public boolean isAutoSplitMessage()
```
    Enable or disable automatic message splitting to fit getMaxLineLength() to prevent the IRC server from possibly truncating or rejecting the line, default true.
  - isAutoNickChange
```
@Generated(value="lombok")
public boolean isAutoNickChange()
```
    Enable or disable automatic nick changing if a nick is in use by adding a number to the end, default false which will throw a IrcException if the nick is already in use on the server
  - getMessageDelay
```
@Generated(value="lombok")
public Delay getMessageDelay()
```
    Millisecond delay between sending messages, default 1000 milliseconds
  - isShutdownHookEnabled
```
@Generated(value="lombok")
public boolean isShutdownHookEnabled()
```
    Enable or disable creating a JVM shutdown hook which will properly QUIT the IRC server and shutdown the bot, default true
  - getAutoJoinChannels
```
@Generated(value="lombok")
public Map<String,String> getAutoJoinChannels()
```
    Map of channels and keys to automatically join upon connecting.
  - isOnJoinWhoEnabled
```
@Generated(value="lombok")
public boolean isOnJoinWhoEnabled()
```
    Enable or disable sending "WHO #channel" upon joining a channel and rely only on the NAMES response
  - isIdentServerEnabled
```
@Generated(value="lombok")
public boolean isIdentServerEnabled()
```
    Enable or disable use of an existing IdentServer, default false. Note that the IdentServer must be started separately or else an exception will be thrown
    
    See Also:
    
    IdentServer
  - getNickservPassword
```
@Generated(value="lombok")
public String getNickservPassword()
```
    Password to authenticate against NICKSERV, default null (will not try to identify)
  - getNickservOnSuccess
```
@Generated(value="lombok")
public String getNickservOnSuccess()
```
    Case-insensitive message a user with setNickservNick(java.lang.String) in its hostmask will always contain when we have successfully identified, defaults to "you are now" which which matches all of the following known server responses:
    - ircd-seven (freenode) - You are now identified for PircBotX
    - Unreal (swiftirc) - Password accepted - you are now recognized.
    - InspIRCd (mozilla) - You are now logged in as PircBotX
    See Also:
    
    PircBotX.isNickservIdentified(), setNickservNick(java.lang.String)
  - getNickservNick
```
@Generated(value="lombok")
public String getNickservNick()
```
    The nick of the nickserv service account, default "nickserv".
    
    See Also:
    
    PircBotX.isNickservIdentified()
  - getNickservCustomMessage
```
@Generated(value="lombok")
public String getNickservCustomMessage()
```
    Some irc servers require a custom identify string. eg: Quakenet: PRIVMSG Q@CServe.quakenet.org :AUTH USER PASS default = null
  - isNickservDelayJoin
```
@Generated(value="lombok")
public boolean isNickservDelayJoin()
```
    Delay joining channels until were identified to nickserv, default false
  - isUserModeHideRealHost
```
@Generated(value="lombok")
public boolean isUserModeHideRealHost()
```
    Sets mode +x on the bot, to hide the real hostname, default = false
  - isAutoReconnect
```
@Generated(value="lombok")
public boolean isAutoReconnect()
```
    Enable or disable automatic reconnecting, default false. Note that you MUST call PircBotX.stopBotReconnect() when you do not want the bot to reconnect anymore!
  - getAutoReconnectDelay
```
@Generated(value="lombok")
public Delay getAutoReconnectDelay()
```
    Delay in milliseconds between reconnect attempts, default 0.
  - getAutoReconnectAttempts
```
@Generated(value="lombok")
public int getAutoReconnectAttempts()
```
    Number of times to attempt to reconnect, default 5.
  - isCapEnabled
```
@Generated(value="lombok")
public boolean isCapEnabled()
```
    Enable or disable CAP handling, defaults true.
  - getCapHandlers
```
@Generated(value="lombok")
public List<CapHandler> getCapHandlers()
```
    IRCv3 CAP features to try to use, default enables multi-prefix and away-notify but ignoring if the server doesn't support them
  - getChannelModeHandlers
```
@Generated(value="lombok")
public List<ChannelModeHandler> getChannelModeHandlers()
```
    Handlers for channel modes, defaults to built-in handlers which cover basic modes that are generally supported on most IRC servers
  - getBotFactory
```
@Generated(value="lombok")
public Configuration.BotFactory getBotFactory()
```
    The Configuration.BotFactory to use
  - setWebIrcEnabled
```
@Generated(value="lombok")
public Configuration.Builder setWebIrcEnabled(boolean webIrcEnabled)
```
    Enable or disable sending WEBIRC line on connect, default disabled
    
    Returns:
    
    this
  - setWebIrcUsername
```
@Generated(value="lombok")
public Configuration.Builder setWebIrcUsername(String webIrcUsername)
```
    Username of WEBIRC connection, must not be blank if WEBIRC is enabled
    
    Returns:
    
    this
  - setWebIrcHostname
```
@Generated(value="lombok")
public Configuration.Builder setWebIrcHostname(String webIrcHostname)
```
    Hostname of WEBIRC connection, must not be blank if WEBIRC is enabled
    
    Returns:
    
    this
  - setWebIrcAddress
```
@Generated(value="lombok")
public Configuration.Builder setWebIrcAddress(InetAddress webIrcAddress)
```
    IP address of WEBIRC connection, must be set if WEBIRC is enabled
    
    Returns:
    
    this
  - setWebIrcPassword
```
@Generated(value="lombok")
public Configuration.Builder setWebIrcPassword(String webIrcPassword)
```
    Password of WEBIRC connection, must not be blank if WEBIRC is enabled
    
    Returns:
    
    this
  - setName
```
@Generated(value="lombok")
public Configuration.Builder setName(String name)
```
    The nick to be used for the IRC connection (nick!login@host), must not be blank
    
    Returns:
    
    this
  - setLogin
```
@Generated(value="lombok")
public Configuration.Builder setLogin(String login)
```
    The login to be used for the IRC connection (nick!login@host), default PircBotX
    
    Returns:
    
    this
  - setVersion
```
@Generated(value="lombok")
public Configuration.Builder setVersion(String version)
```
    CTCP version response.
    
    Returns:
    
    this
  - setFinger
```
@Generated(value="lombok")
public Configuration.Builder setFinger(String finger)
```
    CTCP finger response
    
    Returns:
    
    this
  - setRealName
```
@Generated(value="lombok")
public Configuration.Builder setRealName(String realName)
```
    The realName/fullname used for WHOIS info, defaults to version
    
    Returns:
    
    this
  - setChannelPrefixes
```
@Generated(value="lombok")
public Configuration.Builder setChannelPrefixes(String channelPrefixes)
```
    Allowed channel prefix characters, default #&+!
    
    Returns:
    
    this
  - setUserLevelPrefixes
```
@Generated(value="lombok")
public Configuration.Builder setUserLevelPrefixes(String userLevelPrefixes)
```
    Supported channel prefixes that restrict a sent message to users with this mode, eg PRIVMSG +#channel :hello will only send a message to voiced or higher users, default +@%&~!
    
    Returns:
    
    this
  - setSnapshotsEnabled
```
@Generated(value="lombok")
public Configuration.Builder setSnapshotsEnabled(boolean snapshotsEnabled)
```
    Enable creation of snapshots, default true. In bulk datasets or very lower power devices, creating snapshots can be a relatively expensive operation for every GenericSnapshotEvent (eg PartEvent, QuitEvent) since the entire UserChannelDao with all of its users and channels is cloned. This can optionally disabled by setting this to false, however this makes all GenericSnapshotEvent.getUserChannelDaoSnapshot() calls return null.
    In regular usage disabling snapshots is not necessary because there relatively few user QUITs and PARTs per second.
    
    Returns:
    
    this
  - setDccFilenameQuotes
```
@Generated(value="lombok")
public Configuration.Builder setDccFilenameQuotes(boolean dccFilenameQuotes)
```
    If true sends filenames in quotes, otherwise uses underscores, default enabled.
    
    Returns:
    
    this
  - setDccPorts
```
@Generated(value="lombok")
public Configuration.Builder setDccPorts(List<Integer> dccPorts)
```
    Ports to allow DCC incoming connections, recommended to set multiple as DCC connections will be rejected if no free port can be found
    
    Returns:
    
    this
  - setDccLocalAddress
```
@Generated(value="lombok")
public Configuration.Builder setDccLocalAddress(InetAddress dccLocalAddress)
```
    The local address to bind DCC connections to, defaults to null (which will be figured out at runtime)
    
    Returns:
    
    this
  - setDccPublicAddress
```
@Generated(value="lombok")
public Configuration.Builder setDccPublicAddress(InetAddress dccPublicAddress)
```
    The public address advertised to other users, defaults to null (which will be figured out at runtime)
    
    Returns:
    
    this
  - setDccAcceptTimeout
```
@Generated(value="lombok")
public Configuration.Builder setDccAcceptTimeout(int dccAcceptTimeout)
```
    Timeout for user to accept a sent DCC request, defaults to getSocketTimeout()
    
    Returns:
    
    this
  - setDccResumeAcceptTimeout
```
@Generated(value="lombok")
public Configuration.Builder setDccResumeAcceptTimeout(int dccResumeAcceptTimeout)
```
    Timeout for a user to accept a resumed DCC request, defaults to getDccResumeAcceptTimeout()
    
    Returns:
    
    this
  - setDccTransferBufferSize
```
@Generated(value="lombok")
public Configuration.Builder setDccTransferBufferSize(int dccTransferBufferSize)
```
    Size of the DCC file transfer buffer, default 1024 bytes
    
    Returns:
    
    this
  - setDccPassiveRequest
```
@Generated(value="lombok")
public Configuration.Builder setDccPassiveRequest(boolean dccPassiveRequest)
```
    Send DCC requests as passive/reverse requests if not specified otherwise, default false
    
    Returns:
    
    this
  - setServers
```
@Generated(value="lombok")
public Configuration.Builder setServers(List<Configuration.ServerEntry> servers)
```
    List of servers to connect to, easily add with the addServer methods
    
    Returns:
    
    this
  - setServerPassword
```
@Generated(value="lombok")
public Configuration.Builder setServerPassword(String serverPassword)
```
    Password for IRC server, default null
    
    Returns:
    
    this
  - setSocketFactory
```
@Generated(value="lombok")
public Configuration.Builder setSocketFactory(SocketFactory socketFactory)
```
    Socket factory for connections, defaults to SocketFactory.getDefault()
    
    Returns:
    
    this
  - setLocalAddress
```
@Generated(value="lombok")
public Configuration.Builder setLocalAddress(InetAddress localAddress)
```
    Address to bind to when connecting to IRC server, default null
    
    Returns:
    
    this
  - setEncoding
```
@Generated(value="lombok")
public Configuration.Builder setEncoding(Charset encoding)
```
    Charset encoding to use for connection, defaults to Charset.defaultCharset()
    
    Returns:
    
    this
  - setLocale
```
@Generated(value="lombok")
public Configuration.Builder setLocale(Locale locale)
```
    Locale to use for connection, defaults to Locale.getDefault()
    
    Returns:
    
    this
  - setSocketConnectTimeout
```
@Generated(value="lombok")
public Configuration.Builder setSocketConnectTimeout(int socketConnectTimeout)
```
    Milliseconds to wait to connect to an IRC server address before trying the next address, default getSocketTimeout()
    
    Returns:
    
    this
  - setSocketTimeout
```
@Generated(value="lombok")
public Configuration.Builder setSocketTimeout(int socketTimeout)
```
    Milliseconds to wait with no data from the IRC server before sending a PING request to check if the socket is still alive, default 5 minutes (1000x60x5=300,000 milliseconds)
    
    Returns:
    
    this
  - setMaxLineLength
```
@Generated(value="lombok")
public Configuration.Builder setMaxLineLength(int maxLineLength)
```
    Maximum line length of IRC server, defaults 512 characters
    
    Returns:
    
    this
  - setAutoSplitMessage
```
@Generated(value="lombok")
public Configuration.Builder setAutoSplitMessage(boolean autoSplitMessage)
```
    Enable or disable automatic message splitting to fit getMaxLineLength() to prevent the IRC server from possibly truncating or rejecting the line, default true.
    
    Returns:
    
    this
  - setAutoNickChange
```
@Generated(value="lombok")
public Configuration.Builder setAutoNickChange(boolean autoNickChange)
```
    Enable or disable automatic nick changing if a nick is in use by adding a number to the end, default false which will throw a IrcException if the nick is already in use on the server
    
    Returns:
    
    this
  - setMessageDelay
```
@Generated(value="lombok")
public Configuration.Builder setMessageDelay(Delay messageDelay)
```
    Millisecond delay between sending messages, default 1000 milliseconds
    
    Returns:
    
    this
  - setShutdownHookEnabled
```
@Generated(value="lombok")
public Configuration.Builder setShutdownHookEnabled(boolean shutdownHookEnabled)
```
    Enable or disable creating a JVM shutdown hook which will properly QUIT the IRC server and shutdown the bot, default true
    
    Returns:
    
    this
  - setOnJoinWhoEnabled
```
@Generated(value="lombok")
public Configuration.Builder setOnJoinWhoEnabled(boolean onJoinWhoEnabled)
```
    Enable or disable sending "WHO #channel" upon joining a channel and rely only on the NAMES response
    
    Returns:
    
    this
  - setIdentServerEnabled
```
@Generated(value="lombok")
public Configuration.Builder setIdentServerEnabled(boolean identServerEnabled)
```
    Enable or disable use of an existing IdentServer, default false. Note that the IdentServer must be started separately or else an exception will be thrown
    
    Returns:
    
    this
    
    See Also:
    
    IdentServer
  - setNickservPassword
```
@Generated(value="lombok")
public Configuration.Builder setNickservPassword(String nickservPassword)
```
    Password to authenticate against NICKSERV, default null (will not try to identify)
    
    Returns:
    
    this
  - setNickservOnSuccess
```
@Generated(value="lombok")
public Configuration.Builder setNickservOnSuccess(String nickservOnSuccess)
```
    Case-insensitive message a user with setNickservNick(java.lang.String) in its hostmask will always contain when we have successfully identified, defaults to "you are now" which which matches all of the following known server responses:
    - ircd-seven (freenode) - You are now identified for PircBotX
    - Unreal (swiftirc) - Password accepted - you are now recognized.
    - InspIRCd (mozilla) - You are now logged in as PircBotX
    Returns:
    
    this
    
    See Also:
    
    PircBotX.isNickservIdentified(), setNickservNick(java.lang.String)
  - setNickservNick
```
@Generated(value="lombok")
public Configuration.Builder setNickservNick(String nickservNick)
```
    The nick of the nickserv service account, default "nickserv".
    
    Returns:
    
    this
    
    See Also:
    
    PircBotX.isNickservIdentified()
  - setNickservCustomMessage
```
@Generated(value="lombok")
public Configuration.Builder setNickservCustomMessage(String nickservCustomMessage)
```
    Some irc servers require a custom identify string. eg: Quakenet: PRIVMSG Q@CServe.quakenet.org :AUTH USER PASS default = null
    
    Returns:
    
    this
  - setNickservDelayJoin
```
@Generated(value="lombok")
public Configuration.Builder setNickservDelayJoin(boolean nickservDelayJoin)
```
    Delay joining channels until were identified to nickserv, default false
    
    Returns:
    
    this
  - setUserModeHideRealHost
```
@Generated(value="lombok")
public Configuration.Builder setUserModeHideRealHost(boolean userModeHideRealHost)
```
    Sets mode +x on the bot, to hide the real hostname, default = false
    
    Returns:
    
    this
  - setAutoReconnect
```
@Generated(value="lombok")
public Configuration.Builder setAutoReconnect(boolean autoReconnect)
```
    Enable or disable automatic reconnecting, default false. Note that you MUST call PircBotX.stopBotReconnect() when you do not want the bot to reconnect anymore!
    
    Returns:
    
    this
  - setAutoReconnectDelay
```
@Generated(value="lombok")
public Configuration.Builder setAutoReconnectDelay(Delay autoReconnectDelay)
```
    Delay in milliseconds between reconnect attempts, default 0.
    
    Returns:
    
    this
  - setAutoReconnectAttempts
```
@Generated(value="lombok")
public Configuration.Builder setAutoReconnectAttempts(int autoReconnectAttempts)
```
    Number of times to attempt to reconnect, default 5.
    
    Returns:
    
    this
  - setCapEnabled
```
@Generated(value="lombok")
public Configuration.Builder setCapEnabled(boolean capEnabled)
```
    Enable or disable CAP handling, defaults true.
    
    Returns:
    
    this
  - setBotFactory
```
@Generated(value="lombok")
public Configuration.Builder setBotFactory(Configuration.BotFactory botFactory)
```
    The Configuration.BotFactory to use
    
    Returns:
    
    this
  - equals
```
@Generated(value="lombok")
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
@Generated(value="lombok")
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
@Generated(value="lombok")
public String toString()
```
    Overrides:
    
    toString in class Object

Class Configuration.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Builder

Builder

Method Detail

getSocketConnectTimeout

getDccAcceptTimeout

getDccResumeAcceptTimeout

addCapHandlers

addCapHandler

addListeners

addListener

addAutoJoinChannels

addAutoJoinChannel

addAutoJoinChannel

setServer

setServer

setServerHostname

setServerPort

addServer

addServer

addServer

addServers

setListenerManager

replaceCoreHooksListener

getListenerManager

buildConfiguration

buildForServer

buildForServer

buildForServer

isWebIrcEnabled

getWebIrcUsername

getWebIrcHostname

getWebIrcAddress

getWebIrcPassword

getName

getLogin

getVersion

getFinger

getRealName

getChannelPrefixes

getUserLevelPrefixes

isSnapshotsEnabled

isDccFilenameQuotes

getDccPorts

getDccLocalAddress

getDccPublicAddress

getDccTransferBufferSize

isDccPassiveRequest

getServers

getServerPassword

getSocketFactory

getLocalAddress

getEncoding

getLocale

getSocketTimeout

getMaxLineLength

isAutoSplitMessage

isAutoNickChange

getMessageDelay

isShutdownHookEnabled

getAutoJoinChannels

isOnJoinWhoEnabled

isIdentServerEnabled

getNickservPassword

getNickservOnSuccess

getNickservNick

getNickservCustomMessage

isNickservDelayJoin

isUserModeHideRealHost

isAutoReconnect

getAutoReconnectDelay

getAutoReconnectAttempts

isCapEnabled

getCapHandlers

getChannelModeHandlers