Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W Y 

A

AbstractListenerManager - Class in org.pircbotx.hooks.managers
 
AbstractListenerManager() - Constructor for class org.pircbotx.hooks.managers.AbstractListenerManager
 
accept() - Method in class org.pircbotx.hooks.events.IncomingChatRequestEvent
 
accept(File) - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
 
acceptAndTransfer(File) - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
Accept the request and transfer the file now, blocking until finished.
acceptChatRequest(IncomingChatRequestEvent) - Method in class org.pircbotx.dcc.DccHandler
Accept chat request, blocking until the connection is active
acceptFileTransfer(IncomingFileTransferEvent, File) - Method in class org.pircbotx.dcc.DccHandler
Accept file transfer at position 0, blocking until the connection is active
acceptFileTransferResume(IncomingFileTransferEvent, File, long) - Method in class org.pircbotx.dcc.DccHandler
Accept file transfer resuming at specified position, blocking until the connection is active
acceptResume(File, long) - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
 
acceptResumeAndTransfer(File, long) - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
Accept the resume request and transfer the file now, blocking until finished.
action(String) - Method in interface org.pircbotx.output.GenericChannelUserOutput
Send an action to the represented user or channel.
action(String) - Method in class org.pircbotx.output.OutputChannel
Send an action to the channel.
action(String, String) - Method in class org.pircbotx.output.OutputIRC
Sends an action to the channel or to a user.
action(String) - Method in class org.pircbotx.output.OutputUser
Send an action to the serverUser.
ActionEvent - Class in org.pircbotx.hooks.events
Called whenever an ACTION is sent from a user.
ActionEvent(PircBotX, UserHostmask, User, Channel, String, String, ImmutableMap<String, String>) - Constructor for class org.pircbotx.hooks.events.ActionEvent
 
AdaptingDelay - Class in org.pircbotx.delay
 
AdaptingDelay(long, long) - Constructor for class org.pircbotx.delay.AdaptingDelay
 
addAutoJoinChannel(String) - Method in class org.pircbotx.Configuration.Builder
Add a channel to join on connect
addAutoJoinChannel(String, String) - Method in class org.pircbotx.Configuration.Builder
Utility method for Configuration.Builder.getAutoJoinChannels().put(channel, key)
addAutoJoinChannels(Iterable<String>) - Method in class org.pircbotx.Configuration.Builder
 
addBot(Configuration) - Method in class org.pircbotx.MultiBotManager
addBot(PircBotX) - Method in class org.pircbotx.MultiBotManager
addBotToMDC(PircBotX) - Static method in class org.pircbotx.Utils
 
addCapHandler(CapHandler) - Method in class org.pircbotx.Configuration.Builder
Add a cap handler
addCapHandlers(Iterable<CapHandler>) - Method in class org.pircbotx.Configuration.Builder
Add a collection of cap handlers
addListener(Listener) - Method in class org.pircbotx.Configuration.Builder
Add a listener to the current ListenerManager
addListener(Listener, boolean) - Method in class org.pircbotx.hooks.managers.BackgroundListenerManager
 
addListener(Listener) - Method in class org.pircbotx.hooks.managers.GenericListenerManager
Deprecated.
 
addListener(Listener) - Method in interface org.pircbotx.hooks.managers.ListenerManager
Add a listener to this ListenerManager
addListener(Listener) - Method in class org.pircbotx.hooks.managers.SequentialListenerManager
Alias of #appendListenerPooled(org.pircbotx.hooks.Listener)
addListener(Listener) - Method in class org.pircbotx.hooks.managers.ThreadedListenerManager
 
addListenerExecutor(Listener, SequentialListenerManager.ListenerExecutor) - Method in class org.pircbotx.hooks.managers.SequentialListenerManager
Add a listener to be executed by the supplied executor
addListenerExecutor(int, Listener, SequentialListenerManager.ListenerExecutor) - Method in class org.pircbotx.hooks.managers.SequentialListenerManager
Add a listener at the given index to be executed by the supplied executor
addListenerInline(Listener) - Method in class org.pircbotx.hooks.managers.SequentialListenerManager
Add listener to be executed in the "bot/network loop"
addListenerPooled(Listener) - Method in class org.pircbotx.hooks.managers.SequentialListenerManager
Add listener to be executed in the main executor pool
addListenerPooled(Listener, Executor) - Method in class org.pircbotx.hooks.managers.SequentialListenerManager
Add listener to be executed in the supplied executor pool
addListeners(Iterable<Listener>) - Method in class org.pircbotx.Configuration.Builder
Add a collection of listeners to the current ListenerManager
addListenerSequential(Listener) - Method in class org.pircbotx.hooks.managers.SequentialListenerManager
Add listener to be executed in its sequential single thread
addNetwork(Configuration) - Method in class org.pircbotx.MultiBotManager
Adds a managed bot using the specified configuration.
addNetwork(PircBotX) - Method in class org.pircbotx.MultiBotManager
Adds a bot to be managed.
addressToInteger(InetAddress) - Static method in class org.pircbotx.dcc.DccHandler
 
addServer(String) - Method in class org.pircbotx.Configuration.Builder
 
addServer(String, int) - Method in class org.pircbotx.Configuration.Builder
 
addServer(Configuration.ServerEntry) - Method in class org.pircbotx.Configuration.Builder
 
addServers(Iterable<Configuration.ServerEntry>) - Method in class org.pircbotx.Configuration.Builder
 
addUserToChannel(U, C) - Method in class org.pircbotx.UserChannelMap
 
awayMessage(String) - Method in class org.pircbotx.hooks.events.WhoisEvent.Builder
 

B

BackgroundListenerManager - Class in org.pircbotx.hooks.managers
ThreadListenerManager with additional dedicated background threads.
BackgroundListenerManager() - Constructor for class org.pircbotx.hooks.managers.BackgroundListenerManager
 
ban(String) - Method in class org.pircbotx.output.OutputChannel
Bans a user from a channel.
BanListEvent - Class in org.pircbotx.hooks.events
 
BanListEvent(PircBotX, Channel, ImmutableList<BanListEvent.Entry>) - Constructor for class org.pircbotx.hooks.events.BanListEvent
 
BanListEvent.Entry - Class in org.pircbotx.hooks.events
 
bg(String, String) - Static method in class org.pircbotx.Colors
Set text and background color
BinaryBackoffDelay - Class in org.pircbotx.delay
 
BinaryBackoffDelay(long, long) - Constructor for class org.pircbotx.delay.BinaryBackoffDelay
 
BLACK - Static variable in class org.pircbotx.Colors
Black coloured text.
BLUE - Static variable in class org.pircbotx.Colors
Blue coloured text.
BOLD - Static variable in class org.pircbotx.Colors
Bold text.
BotFactory() - Constructor for class org.pircbotx.Configuration.BotFactory
 
BROWN - Static variable in class org.pircbotx.Colors
Brown coloured text.
build() - Method in class org.pircbotx.hooks.managers.SequentialListenerManager.SequentialListenerManagerBuilder
 
buildConfiguration() - Method in class org.pircbotx.Configuration.Builder
Builds a Configuration instance from the information in this builder
Builder() - Constructor for class org.pircbotx.Configuration.Builder
Create with defaults that work in most situations and IRC servers
Builder(Configuration) - Constructor for class org.pircbotx.Configuration.Builder
Copy values from an existing Configuration.
Builder(Configuration.Builder) - Constructor for class org.pircbotx.Configuration.Builder
Copy values from another builder.
builder() - Static method in class org.pircbotx.hooks.events.WhoisEvent
 
builder() - Static method in class org.pircbotx.hooks.managers.SequentialListenerManager
 
buildForServer(String) - Method in class org.pircbotx.Configuration.Builder
Create a new builder with the specified hostname then build a configuration.
buildForServer(String, int) - Method in class org.pircbotx.Configuration.Builder
Create a new builder with the specified hostname and port then build a configuration.
buildForServer(String, int, String) - Method in class org.pircbotx.Configuration.Builder
Create a new builder with the specified hostname, port, and password then build a configuration.

C

CAPException - Exception in org.pircbotx.exception
General Exception for problems during CAP negotiation
CAPException(CAPException.Reason, String) - Constructor for exception org.pircbotx.exception.CAPException
 
CAPException(CAPException.Reason, String, Throwable) - Constructor for exception org.pircbotx.exception.CAPException
 
CAPException.Reason - Enum in org.pircbotx.exception
 
CapHandler - Interface in org.pircbotx.cap
Generic CAP handler.
changeNick(String) - Method in class org.pircbotx.output.OutputIRC
Attempt to change the current nick (nickname) of the bot when it is connected to an IRC server.
Channel - Class in org.pircbotx
Represents a Channel that we're joined to.
channelExists(String) - Method in class org.pircbotx.UserChannelDao
Deprecated.
Renamed UserChannelDao.containsChannel(java.lang.String) to match the Java Collections API
ChannelInfoEvent - Class in org.pircbotx.hooks.events
After calling the listChannels() method in PircBotX, the server will start to send us information about each channel on the server.
ChannelInfoEvent(PircBotX, ImmutableList<ChannelListEntry>) - Constructor for class org.pircbotx.hooks.events.ChannelInfoEvent
 
ChannelListEntry - Class in org.pircbotx
A channel entry returned from /LIST command.
ChannelListEntry(String, int, String) - Constructor for class org.pircbotx.ChannelListEntry
 
ChannelModeHandler - Class in org.pircbotx
 
ChannelModeHandler(char) - Constructor for class org.pircbotx.ChannelModeHandler
 
channels(ImmutableList<String>) - Method in class org.pircbotx.hooks.events.WhoisEvent.Builder
 
ChannelSnapshot - Class in org.pircbotx.snapshot
 
ChannelSnapshot(Channel, String) - Constructor for class org.pircbotx.snapshot.ChannelSnapshot
 
Chat - Class in org.pircbotx.dcc
Generic DCC chat handling class that represents an active dcc chat.
chatPassiveAccept(String, InetAddress, int, String) - Method in class org.pircbotx.output.OutputDCC
 
chatPassiveRequest(String, InetAddress, String) - Method in class org.pircbotx.output.OutputDCC
 
chatRequest(String, InetAddress, int) - Method in class org.pircbotx.output.OutputDCC
 
checkClientTrusted(X509Certificate[], String) - Method in class org.pircbotx.UtilSSLSocketFactory.TrustingX509TrustManager
Doesn't throw an exception, so this is how it approves a certificate.
checkServerTrusted(X509Certificate[], String) - Method in class org.pircbotx.UtilSSLSocketFactory.TrustingX509TrustManager
Doesn't throw an exception, so this is how it approves a certificate.
clear() - Method in class org.pircbotx.output.OutputCAP
 
clear() - Method in class org.pircbotx.snapshot.UserChannelMapSnapshot
 
clear() - Method in class org.pircbotx.UserChannelMap
 
close() - Method in class org.pircbotx.dcc.Chat
Closes the DCC Chat connection.
close() - Method in class org.pircbotx.dcc.DccHandler
Shutdown any pending dcc transfers
close() - Method in class org.pircbotx.hooks.managers.SequentialListenerManager.InlineListenerExecutor
 
close() - Method in class org.pircbotx.hooks.managers.SequentialListenerManager.PooledListenerExecutor
 
close() - Method in class org.pircbotx.hooks.WaitForQueue
Shuts down the queue; VERY important to call when finished.
close() - Method in class org.pircbotx.IdentServer
close() - Method in class org.pircbotx.InputParser
Clear out builders.
close() - Method in class org.pircbotx.PircBotX
If for some reason you absolutely need to stop PircBotX now instead of gracefully closing with OutputIRC.quitServer(), this will close the socket which causes read loop to terminate which will shutdown PircBotX shortly.
close() - Method in class org.pircbotx.snapshot.UserChannelDaoSnapshot
 
close() - Method in class org.pircbotx.UserChannelDao
Clears all internal maps
Colors - Class in org.pircbotx
The Colors class provides several static fields and methods that you may find useful when writing an IRC Bot.
COLORS_TABLE - Static variable in class org.pircbotx.Colors
Pre-built lookup table by String for all available colors
compareTo(Channel) - Method in class org.pircbotx.Channel
compareTo(Event) - Method in class org.pircbotx.hooks.Event
Compare events by Event.getTimestamp() and then Event.getId() to order by when they are received.
compareTo(PircBotX) - Method in class org.pircbotx.PircBotX
Compare bot id's.
compareTo(User) - Method in class org.pircbotx.UserHostmask
Configuration - Class in org.pircbotx
Immutable configuration for PircBotX created from Configuration.Builder
Configuration.BotFactory - Class in org.pircbotx
Factory for various internal bot classes.
Configuration.Builder - Class in org.pircbotx
Builder to create an immutable Configuration.
Configuration.ServerEntry - Class in org.pircbotx
 
ConnectAttemptFailedEvent - Class in org.pircbotx.hooks.events
 
ConnectAttemptFailedEvent(PircBotX, int, ImmutableMap<InetSocketAddress, Exception>) - Constructor for class org.pircbotx.hooks.events.ConnectAttemptFailedEvent
 
ConnectEvent - Class in org.pircbotx.hooks.events
This event is dispatched once we successfully connected to the IRC server.
ConnectEvent(PircBotX) - Constructor for class org.pircbotx.hooks.events.ConnectEvent
Default constructor to setup object.
containsChannel(String) - Method in class org.pircbotx.UserChannelDao
Check if we are currently in the given channel
containsEntry(U, C) - Method in class org.pircbotx.UserChannelMap
 
containsMode(char) - Method in class org.pircbotx.Channel
 
containsUser(String) - Method in class org.pircbotx.UserChannelDao
Check if user exists by nick
containsUser(UserHostmask) - Method in class org.pircbotx.UserChannelDao
Check if user exists by hostmask
containsUser(User) - Method in class org.pircbotx.UserChannelMap
 
CoreHooks - Class in org.pircbotx.hooks
Several standard IRC client default responses.
CoreHooks() - Constructor for class org.pircbotx.hooks.CoreHooks
 
createChannel(PircBotX, String) - Method in class org.pircbotx.Configuration.BotFactory
 
createChannel(String) - Method in class org.pircbotx.snapshot.UserChannelDaoSnapshot
 
createChannel(String) - Method in class org.pircbotx.UserChannelDao
Creates a known channel, internally called when we join a channel
createDccHandler(PircBotX) - Method in class org.pircbotx.Configuration.BotFactory
 
createInputParser(PircBotX) - Method in class org.pircbotx.Configuration.BotFactory
 
createOutputCAP(PircBotX) - Method in class org.pircbotx.Configuration.BotFactory
 
createOutputChannel(PircBotX, Channel) - Method in class org.pircbotx.Configuration.BotFactory
 
createOutputDCC(PircBotX) - Method in class org.pircbotx.Configuration.BotFactory
 
createOutputIRC(PircBotX) - Method in class org.pircbotx.Configuration.BotFactory
 
createOutputRaw(PircBotX) - Method in class org.pircbotx.Configuration.BotFactory
 
createOutputUser(PircBotX, UserHostmask) - Method in class org.pircbotx.Configuration.BotFactory
 
createReceiveChat(PircBotX, User, Socket) - Method in class org.pircbotx.Configuration.BotFactory
 
createReceiveFileTransfer(PircBotX, Socket, User, File, long, long) - Method in class org.pircbotx.Configuration.BotFactory
 
createSendChat(PircBotX, User, Socket) - Method in class org.pircbotx.Configuration.BotFactory
 
createSendFileTransfer(PircBotX, Socket, User, File, long) - Method in class org.pircbotx.Configuration.BotFactory
 
createServerInfo(PircBotX) - Method in class org.pircbotx.Configuration.BotFactory
 
createSnapshot() - Method in class org.pircbotx.Channel
Create an immutable snapshot of this channel.
createSnapshot() - Method in class org.pircbotx.snapshot.ChannelSnapshot
 
createSnapshot() - Method in class org.pircbotx.snapshot.UserChannelDaoSnapshot
 
createSnapshot() - Method in class org.pircbotx.snapshot.UserSnapshot
 
createSnapshot() - Method in class org.pircbotx.User
 
createSnapshot() - Method in class org.pircbotx.UserChannelDao
Create an immutable snapshot (copy) of all of contained Users, Channels, and mappings, VERY EXPENSIVE.
createSnapshot(Map<U, UserSnapshot>, Map<C, ChannelSnapshot>) - Method in class org.pircbotx.UserChannelMap
 
createSocket(String, int) - Method in class org.pircbotx.ProxySocketFactory
 
createSocket(String, int, InetAddress, int) - Method in class org.pircbotx.ProxySocketFactory
 
createSocket(InetAddress, int) - Method in class org.pircbotx.ProxySocketFactory
 
createSocket(InetAddress, int, InetAddress, int) - Method in class org.pircbotx.ProxySocketFactory
 
createSocket(String, int) - Method in class org.pircbotx.UtilSSLSocketFactory
 
createSocket(String, int, InetAddress, int) - Method in class org.pircbotx.UtilSSLSocketFactory
 
createSocket(InetAddress, int) - Method in class org.pircbotx.UtilSSLSocketFactory
 
createSocket(InetAddress, int, InetAddress, int) - Method in class org.pircbotx.UtilSSLSocketFactory
 
createSocket(Socket, String, int, boolean) - Method in class org.pircbotx.UtilSSLSocketFactory
 
createSocket(Socket, InputStream, boolean) - Method in class org.pircbotx.UtilSSLSocketFactory
 
createSocket() - Method in class org.pircbotx.UtilSSLSocketFactory
 
createUser(UserHostmask) - Method in class org.pircbotx.Configuration.BotFactory
 
createUser(UserHostmask) - Method in class org.pircbotx.snapshot.UserChannelDaoSnapshot
 
createUser(UserHostmask) - Method in class org.pircbotx.UserChannelDao
Create a user from a hostmask, internally called when a valid, real user contacts us
createUserChannelDao(PircBotX) - Method in class org.pircbotx.Configuration.BotFactory
 
createUserHostmask(PircBotX, String) - Method in class org.pircbotx.Configuration.BotFactory
 
createUserHostmask(PircBotX, String, String, String, String) - Method in class org.pircbotx.Configuration.BotFactory
 
createUserIfNull(User, UserHostmask) - Method in class org.pircbotx.InputParser
 
ctcpCommand(String) - Method in class org.pircbotx.output.OutputChannel
Send a CTCP command to the channel.
ctcpCommand(String, String) - Method in class org.pircbotx.output.OutputIRC
Sends a CTCP command to a channel or user.
ctcpCommand(String) - Method in class org.pircbotx.output.OutputUser
Send a CTCP command to the serverUser.
ctcpResponse(String, String) - Method in class org.pircbotx.output.OutputIRC
Send a CTCP response to the target channel or user.
ctcpResponse(String) - Method in class org.pircbotx.output.OutputUser
Send a CTCP Response to the serverUser.
CYAN - Static variable in class org.pircbotx.Colors
Cyan coloured text.
cycle() - Method in class org.pircbotx.output.OutputChannel
Part and rejoin specified channel.
cycle(String) - Method in class org.pircbotx.output.OutputChannel
Part and rejoin specified channel using channel key.

D

DaoException - Exception in org.pircbotx.exception
 
DaoException(DaoException.Reason, String) - Constructor for exception org.pircbotx.exception.DaoException
 
DaoException(DaoException.Reason, String, Exception) - Constructor for exception org.pircbotx.exception.DaoException
 
DaoException.Reason - Enum in org.pircbotx.exception
 
DARK_BLUE - Static variable in class org.pircbotx.Colors
Dark blue coloured text.
DARK_GRAY - Static variable in class org.pircbotx.Colors
Dark gray coloured text.
DARK_GREEN - Static variable in class org.pircbotx.Colors
Dark green coloured text.
dcc(String, String, Object...) - Method in class org.pircbotx.output.OutputDCC
 
dccChat() - Method in class org.pircbotx.output.OutputUser
 
dccChat(boolean) - Method in class org.pircbotx.output.OutputUser
 
DccException - Exception in org.pircbotx.exception
A general exception for DCC errors
DccException(DccException.Reason, User, String, Throwable) - Constructor for exception org.pircbotx.exception.DccException
 
DccException(DccException.Reason, User, String) - Constructor for exception org.pircbotx.exception.DccException
 
DccException.Reason - Enum in org.pircbotx.exception
 
dccFile(File) - Method in class org.pircbotx.output.OutputUser
 
dccFile(File, boolean) - Method in class org.pircbotx.output.OutputUser
 
dccFileAndTransfer(File) - Method in class org.pircbotx.output.OutputUser
 
dccFileAndTransfer(File, boolean) - Method in class org.pircbotx.output.OutputUser
 
DccHandler - Class in org.pircbotx.dcc
Handler of all DCC requests
DccHandler(PircBotX) - Constructor for class org.pircbotx.dcc.DccHandler
 
DccState - Enum in org.pircbotx.dcc
The state of a DCC connection
deHalfOp(UserHostmask) - Method in class org.pircbotx.output.OutputChannel
Removes owner privileges to a user on a channel.
Delay - Interface in org.pircbotx.delay
Interface to encapsulate delay.
deOp(UserHostmask) - Method in class org.pircbotx.output.OutputChannel
Removes operator privileges from a user on a channel.
deOwner(UserHostmask) - Method in class org.pircbotx.output.OutputChannel
Removes owner privileges to a user on a channel.
deSuperOp(UserHostmask) - Method in class org.pircbotx.output.OutputChannel
Removes superOp privileges to a user on a channel.
deVoice(UserHostmask) - Method in class org.pircbotx.output.OutputChannel
Removes voice privileges from a user on a channel.
disableDiffieHellman() - Method in class org.pircbotx.UtilSSLSocketFactory
Disable the Diffie Hellman key exchange algorithm.
disableDiffieHellman(SSLSocketFactory) - Method in class org.pircbotx.UtilSSLSocketFactory
Disable the Diffie Hellman key exchange algorithm using the provided SSL socket factory.
DisconnectEvent - Class in org.pircbotx.hooks.events
This event is dispatched when we get disconnected.
DisconnectEvent(PircBotX, UserChannelDaoSnapshot, Exception) - Constructor for class org.pircbotx.hooks.events.DisconnectEvent
 
dispatchEvent(PircBotX, Event) - Static method in class org.pircbotx.Utils
 
done() - Method in class org.pircbotx.hooks.TemporaryListener
Remove this listener from the ListenerManager

E

EnableCapHandler - Class in org.pircbotx.cap
Enables the specified capability with the server.
EnableCapHandler(String) - Constructor for class org.pircbotx.cap.EnableCapHandler
Create EnableCapHandler not ignoring if server doesn't support the requested capability
EnableCapHandler(String, boolean) - Constructor for class org.pircbotx.cap.EnableCapHandler
 
end() - Method in class org.pircbotx.output.OutputCAP
 
Entry(UserHostmask, UserHostmask, long) - Constructor for class org.pircbotx.hooks.events.BanListEvent.Entry
 
equals(Object) - Method in class org.pircbotx.Channel
 
equals(Object) - Method in class org.pircbotx.ChannelListEntry
 
equals(Object) - Method in class org.pircbotx.ChannelModeHandler
 
equals(Object) - Method in class org.pircbotx.Configuration.Builder
 
equals(Object) - Method in class org.pircbotx.Configuration
 
equals(Object) - Method in class org.pircbotx.Configuration.ServerEntry
 
equals(Object) - Method in class org.pircbotx.hooks.Event
 
equals(Object) - Method in class org.pircbotx.hooks.events.ActionEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.BanListEvent.Entry
 
equals(Object) - Method in class org.pircbotx.hooks.events.BanListEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.ChannelInfoEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.ConnectAttemptFailedEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.ConnectEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.DisconnectEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.ExceptionEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.FingerEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.HalfOpEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.IncomingChatRequestEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.InviteEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.JoinEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.KickEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.ListenerExceptionEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.MessageEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.ModeEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.MotdEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.NickAlreadyInUseEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.NickChangeEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.NoticeEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.OpEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.OutputEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.OwnerEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.PartEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.PingEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.PrivateMessageEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.QuitEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.RemoveChannelBanEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.RemoveChannelKeyEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.RemoveChannelLimitEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.RemoveInviteOnlyEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.RemoveModeratedEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.RemoveNoExternalMessagesEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.RemovePrivateEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.RemoveSecretEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.RemoveTopicProtectionEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.ServerPingEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.ServerResponseEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.SetChannelBanEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.SetChannelKeyEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.SetChannelLimitEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.SetInviteOnlyEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.SetModeratedEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.SetNoExternalMessagesEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.SetPrivateEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.SetSecretEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.SetTopicProtectionEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.SocketConnectEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.SuperOpEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.TimeEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.TopicEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.UnknownEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.UserListEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.UserModeEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.VersionEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.VoiceEvent
 
equals(Object) - Method in class org.pircbotx.hooks.events.WhoisEvent
 
equals(Object) - Method in class org.pircbotx.PircBotX
 
equals(Object) - Method in class org.pircbotx.ServerInfo
 
equals(Object) - Method in class org.pircbotx.snapshot.UserSnapshot
 
equals(Object) - Method in class org.pircbotx.User
 
equals(Object) - Method in class org.pircbotx.UserHostmask
 
equals(Object) - Method in class org.pircbotx.UtilSSLSocketFactory
 
ERR_ALREADYREGISTRED - Static variable in class org.pircbotx.ReplyConstants
 
ERR_BADCHANMASK - Static variable in class org.pircbotx.ReplyConstants
 
ERR_BADCHANNELKEY - Static variable in class org.pircbotx.ReplyConstants
 
ERR_BANNEDFROMCHAN - Static variable in class org.pircbotx.ReplyConstants
 
ERR_CANNOTSENDTOCHAN - Static variable in class org.pircbotx.ReplyConstants
 
ERR_CANTKILLSERVER - Static variable in class org.pircbotx.ReplyConstants
 
ERR_CHANNELISFULL - Static variable in class org.pircbotx.ReplyConstants
 
ERR_CHANOPRIVSNEEDED - Static variable in class org.pircbotx.ReplyConstants
 
ERR_ERRONEUSNICKNAME - Static variable in class org.pircbotx.ReplyConstants
 
ERR_FILEERROR - Static variable in class org.pircbotx.ReplyConstants
 
ERR_INVITEONLYCHAN - Static variable in class org.pircbotx.ReplyConstants
 
ERR_KEYSET - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NEEDMOREPARAMS - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NICKCOLLISION - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NICKNAMEINUSE - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NOADMININFO - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NOLOGIN - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NOMOTD - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NONICKNAMEGIVEN - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NOOPERHOST - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NOORIGIN - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NOPERMFORHOST - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NOPRIVILEGES - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NORECIPIENT - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NOSERVICEHOST - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NOSUCHCHANNEL - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NOSUCHNICK - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NOSUCHSERVER - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NOTEXTTOSEND - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NOTONCHANNEL - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NOTOPLEVEL - Static variable in class org.pircbotx.ReplyConstants
 
ERR_NOTREGISTERED - Static variable in class org.pircbotx.ReplyConstants
 
ERR_PASSWDMISMATCH - Static variable in class org.pircbotx.ReplyConstants
 
ERR_SUMMONDISABLED - Static variable in class org.pircbotx.ReplyConstants
 
ERR_TARGETTOOFAST - Static variable in class org.pircbotx.ReplyConstants
 
ERR_TOOMANYCHANNELS - Static variable in class org.pircbotx.ReplyConstants
 
ERR_TOOMANYTARGETS - Static variable in class org.pircbotx.ReplyConstants
 
ERR_UMODEUNKNOWNFLAG - Static variable in class org.pircbotx.ReplyConstants
 
ERR_UNKNOWNCOMMAND - Static variable in class org.pircbotx.ReplyConstants
 
ERR_UNKNOWNMODE - Static variable in class org.pircbotx.ReplyConstants
 
ERR_USERNOTINCHANNEL - Static variable in class org.pircbotx.ReplyConstants
 
ERR_USERONCHANNEL - Static variable in class org.pircbotx.ReplyConstants
 
ERR_USERSDISABLED - Static variable in class org.pircbotx.ReplyConstants
 
ERR_USERSDONTMATCH - Static variable in class org.pircbotx.ReplyConstants
 
ERR_WASNOSUCHNICK - Static variable in class org.pircbotx.ReplyConstants
 
ERR_WILDTOPLEVEL - Static variable in class org.pircbotx.ReplyConstants
 
ERR_YOUREBANNEDCREEP - Static variable in class org.pircbotx.ReplyConstants
 
ERR_YOUWILLBEBANNED - Static variable in class org.pircbotx.ReplyConstants
 
Event - Class in org.pircbotx.hooks
An event representing what was received from the IRC server.
Event(PircBotX) - Constructor for class org.pircbotx.hooks.Event
 
ExceptionEvent - Class in org.pircbotx.hooks.events
Dispatched when an Exception is encountered
ExceptionEvent(PircBotX, Exception, String) - Constructor for class org.pircbotx.hooks.events.ExceptionEvent
 
executorPool(Executor) - Method in class org.pircbotx.hooks.managers.SequentialListenerManager.SequentialListenerManagerBuilder
 
exists(boolean) - Method in class org.pircbotx.hooks.events.WhoisEvent.Builder
 

F

filePassiveAccept(String, String, InetAddress, int, long, String) - Method in class org.pircbotx.output.OutputDCC
 
filePassiveRequest(String, String, InetAddress, long, String) - Method in class org.pircbotx.output.OutputDCC
 
filePassiveResumeAccept(String, String, long, String) - Method in class org.pircbotx.output.OutputDCC
 
filePassiveResumeRequest(String, String, long, String) - Method in class org.pircbotx.output.OutputDCC
 
fileRequest(String, String, InetAddress, int, long) - Method in class org.pircbotx.output.OutputDCC
 
fileResumeAccept(String, String, int, long) - Method in class org.pircbotx.output.OutputDCC
 
fileResumeRequest(String, String, int, long) - Method in class org.pircbotx.output.OutputDCC
 
FileTransfer - Class in org.pircbotx.dcc
A general active DCC file transfer
FileTransfer(Configuration, Socket, User, File, long, long) - Constructor for class org.pircbotx.dcc.FileTransfer
 
FingerEvent - Class in org.pircbotx.hooks.events
This event is dispatched whenever we receive a FINGER request.
FingerEvent(PircBotX, UserHostmask, User, Channel) - Constructor for class org.pircbotx.hooks.events.FingerEvent
 
format(String, Object...) - Static method in class org.pircbotx.Utils
 
FORMATTING_TABLE - Static variable in class org.pircbotx.Colors
Pre-built lookup table by String for all available formatting options
fromSymbol(char) - Static method in enum org.pircbotx.UserLevel
Searches for UserLevel that uses the given symbol

G

generateConfig() - Static method in class org.pircbotx.ReplayServer
 
generateEvent(PircBotX) - Method in class org.pircbotx.hooks.events.WhoisEvent.Builder
 
GenericChannelEvent - Interface in org.pircbotx.hooks.types
 
GenericChannelModeEvent - Interface in org.pircbotx.hooks.types
Generic Channel Mode (not users status in the channel) change event

GenericChannelModeRecipientEvent - Interface in org.pircbotx.hooks.types
Generic interface for Channel Op, Voice, Half Op, Super Op, and Owner Events
GenericChannelUserEvent - Interface in org.pircbotx.hooks.types
 
GenericChannelUserOutput - Interface in org.pircbotx.output
Interface for sending lines to the represented user or channel.
GenericCTCPEvent - Interface in org.pircbotx.hooks.types
Any event dealing with CTCP.
GenericDCCEvent - Interface in org.pircbotx.hooks.types
Any event dealing with DCC.
GenericEvent - Interface in org.pircbotx.hooks.types
Base interface that all Generic event interfaces must extend from.
GenericListenerManager - Class in org.pircbotx.hooks.managers
Deprecated.
Due to multiple new functions of PircBotX theat depend on multiple threads, this class is deprecated and is only kept for legacy reasons or special cases. Use of this class will have unexpected results. All bots should now use ThreadedListenerManager.
GenericListenerManager() - Constructor for class org.pircbotx.hooks.managers.GenericListenerManager
Deprecated.
 
GenericMessageEvent - Interface in org.pircbotx.hooks.types
Generic event for an incoming message from a user, whether it be a private message, channel message, channel action, etc.
GenericSnapshotEvent - Interface in org.pircbotx.hooks.types
 
GenericUserEvent - Interface in org.pircbotx.hooks.types
 
GenericUserModeEvent - Interface in org.pircbotx.hooks.types
Any user status change in a channel.
getAcceptedIssuers() - Method in class org.pircbotx.UtilSSLSocketFactory.TrustingX509TrustManager
 
getAction() - Method in class org.pircbotx.hooks.events.ActionEvent
The action message.
getAddress() - Method in class org.pircbotx.hooks.events.IncomingChatRequestEvent
 
getAddress() - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
 
getAddress() - Method in interface org.pircbotx.hooks.types.GenericDCCEvent
 
getAllChannels() - Method in class org.pircbotx.UserChannelDao
Get all currently joined channels
getAllUsers() - Method in class org.pircbotx.UserChannelDao
Get all currently known users, except from just joined channels where the WHO response hasn't finished (listen for UserListEvent instead)
getAutoJoinChannels() - Method in class org.pircbotx.Configuration.Builder
Map of channels and keys to automatically join upon connecting.
getAutoJoinChannels() - Method in class org.pircbotx.Configuration
 
getAutoNewNick() - Method in class org.pircbotx.hooks.events.NickAlreadyInUseEvent
The auto changed nick, if any.
getAutoReconnectAttempts() - Method in class org.pircbotx.Configuration.Builder
Number of times to attempt to reconnect, default 5.
getAutoReconnectAttempts() - Method in class org.pircbotx.Configuration
 
getAutoReconnectDelay() - Method in class org.pircbotx.Configuration.Builder
Delay in milliseconds between reconnect attempts, default 0.
getAutoReconnectDelay() - Method in class org.pircbotx.Configuration
 
getAwayLength() - Method in class org.pircbotx.ServerInfo
 
getAwayMessage() - Method in class org.pircbotx.hooks.events.WhoisEvent
 
getAwayMessage() - Method in class org.pircbotx.User
User's away status
getBanHostmask() - Method in class org.pircbotx.hooks.events.SetChannelBanEvent
The hostmask of the user that has been banned.
getBot() - Method in class org.pircbotx.Channel
 
getBot() - Method in class org.pircbotx.hooks.Event
 
getBot() - Method in interface org.pircbotx.hooks.types.GenericEvent
The PircBotX instance that this event originally came from
getBot() - Method in class org.pircbotx.ServerInfo
 
getBot() - Method in class org.pircbotx.UserHostmask
 
getBotById(int) - Method in class org.pircbotx.MultiBotManager
Lookup a managed bot by id.
getBotFactory() - Method in class org.pircbotx.Configuration.Builder
getBotFactory() - Method in class org.pircbotx.Configuration
 
getBotId() - Method in class org.pircbotx.PircBotX
Unique number for this bot
getBots() - Method in class org.pircbotx.MultiBotManager
Get all the bots that this MultiBotManager is managing.
getBufferedReader() - Method in class org.pircbotx.dcc.Chat
 
getBufferedWriter() - Method in class org.pircbotx.dcc.Chat
 
getBytesTransfered() - Method in class org.pircbotx.dcc.FileTransfer
 
getCap() - Method in class org.pircbotx.cap.EnableCapHandler
 
getCapHandlers() - Method in class org.pircbotx.Configuration.Builder
IRCv3 CAP features to try to use, default enables multi-prefix and away-notify but ignoring if the server doesn't support them
getCapHandlers() - Method in class org.pircbotx.Configuration
 
getCaseMapping() - Method in class org.pircbotx.ServerInfo
 
getChanlimit() - Method in class org.pircbotx.ServerInfo
 
getChannel() - Method in class org.pircbotx.hooks.events.ActionEvent
The channel that the action message was sent in.
getChannel() - Method in class org.pircbotx.hooks.events.BanListEvent
 
getChannel() - Method in class org.pircbotx.hooks.events.FingerEvent
The target channel of the FINGER request.
getChannel() - Method in class org.pircbotx.hooks.events.HalfOpEvent
The channel in which the mode change took place.
getChannel() - Method in class org.pircbotx.hooks.events.InviteEvent
The channel that we're being invited to.
getChannel() - Method in class org.pircbotx.hooks.events.JoinEvent
The channel which somebody joined.
getChannel() - Method in class org.pircbotx.hooks.events.KickEvent
The channel from which the recipient was kicked.
getChannel() - Method in class org.pircbotx.hooks.events.MessageEvent
The channel to which the message was sent.
getChannel() - Method in class org.pircbotx.hooks.events.ModeEvent
The channel that the mode operation applies to.
getChannel() - Method in class org.pircbotx.hooks.events.NoticeEvent
The target channel of the notice.
getChannel() - Method in class org.pircbotx.hooks.events.OpEvent
The channel in which the mode change took place.
getChannel() - Method in class org.pircbotx.hooks.events.OwnerEvent
The channel in which the mode change took place.
getChannel() - Method in class org.pircbotx.hooks.events.PartEvent
Snapshot of the channel as of before the user parted.
getChannel() - Method in class org.pircbotx.hooks.events.PingEvent
The channel that received the ping request.
getChannel() - Method in class org.pircbotx.hooks.events.RemoveChannelBanEvent
The channel in which the mode change took place.
getChannel() - Method in class org.pircbotx.hooks.events.RemoveChannelKeyEvent
 
getChannel() - Method in class org.pircbotx.hooks.events.RemoveChannelLimitEvent
 
getChannel() - Method in class org.pircbotx.hooks.events.RemoveInviteOnlyEvent
 
getChannel() - Method in class org.pircbotx.hooks.events.RemoveModeratedEvent
 
getChannel() - Method in class org.pircbotx.hooks.events.RemoveNoExternalMessagesEvent
 
getChannel() - Method in class org.pircbotx.hooks.events.RemovePrivateEvent
 
getChannel() - Method in class org.pircbotx.hooks.events.RemoveSecretEvent
 
getChannel() - Method in class org.pircbotx.hooks.events.RemoveTopicProtectionEvent
 
getChannel() - Method in class org.pircbotx.hooks.events.SetChannelBanEvent
 
getChannel() - Method in class org.pircbotx.hooks.events.SetChannelKeyEvent
 
getChannel() - Method in class org.pircbotx.hooks.events.SetChannelLimitEvent
 
getChannel() - Method in class org.pircbotx.hooks.events.SetInviteOnlyEvent
 
getChannel() - Method in class org.pircbotx.hooks.events.SetModeratedEvent
 
getChannel() - Method in class org.pircbotx.hooks.events.SetNoExternalMessagesEvent
 
getChannel() - Method in class org.pircbotx.hooks.events.SetPrivateEvent
 
getChannel() - Method in class org.pircbotx.hooks.events.SetSecretEvent
 
getChannel() - Method in class org.pircbotx.hooks.events.SetTopicProtectionEvent
The channel in which the mode change took place.
getChannel() - Method in class org.pircbotx.hooks.events.SuperOpEvent
The channel in which the mode change took place.
getChannel() - Method in class org.pircbotx.hooks.events.TimeEvent
The target channel of the TIME request.
getChannel() - Method in class org.pircbotx.hooks.events.TopicEvent
The channel that the topic belongs to.
getChannel() - Method in class org.pircbotx.hooks.events.UserListEvent
The channel that the user list is from.
getChannel() - Method in class org.pircbotx.hooks.events.VersionEvent
The target channel of the VERSION request.
getChannel() - Method in class org.pircbotx.hooks.events.VoiceEvent
The channel in which the mode change took place.
getChannel() - Method in interface org.pircbotx.hooks.types.GenericChannelEvent
The source channel where this event took place.
getChannel(String) - Method in class org.pircbotx.UserChannelDao
Lookup channel by name, throwing a DaoException if not found
getChannelId() - Method in class org.pircbotx.Channel
Unique UUID for this channel instance
getChannelIDLength() - Method in class org.pircbotx.ServerInfo
 
getChannelKey() - Method in class org.pircbotx.Channel
Channel key (+k)
getChannelLength() - Method in class org.pircbotx.ServerInfo
 
getChannelLimit() - Method in class org.pircbotx.Channel
Channel limit (+l #)
getChannelModeHandlers() - Method in class org.pircbotx.Configuration.Builder
Handlers for channel modes, defaults to built-in handlers which cover basic modes that are generally supported on most IRC servers
getChannelModeHandlers() - Method in class org.pircbotx.Configuration
 
getChannelModes() - Method in class org.pircbotx.ServerInfo
 
getChannelName() - Method in class org.pircbotx.hooks.events.PartEvent
Name of channel the user parted from.
getChannelPrefixes() - Method in class org.pircbotx.Configuration.Builder
Allowed channel prefix characters, default #&+!
getChannelPrefixes() - Method in class org.pircbotx.Configuration
 
getChannels() - Method in class org.pircbotx.hooks.events.WhoisEvent
 
getChannels() - Method in class org.pircbotx.User
Get all channels this user is a part of.
getChannels(U, UserLevel) - Method in class org.pircbotx.UserChannelDao
Gets all currently known channels the user is a part of with the specified level.
getChannels(U) - Method in class org.pircbotx.UserChannelDao
Get channels we're joined to that the user is joined to as well
getChannels(U) - Method in class org.pircbotx.UserChannelMap
 
getChannelsHalfOpIn() - Method in class org.pircbotx.User
Get all channels user has Half Operator status in.
getChannelsOpIn() - Method in class org.pircbotx.User
Get all channels user has Operator status in.
getChannelSource() - Method in class org.pircbotx.hooks.events.ActionEvent
The raw channel name, could be a special mode message eg +#channel that only goes to voiced users.
getChannelSource() - Method in class org.pircbotx.hooks.events.MessageEvent
The raw channel name, could be a special mode message eg +#channel that only goes to voiced users.
getChannelSource() - Method in class org.pircbotx.hooks.events.NoticeEvent
The raw channel name, could be a special mode message eg +#channel that only goes to voiced users.
getChannelsOwnerIn() - Method in class org.pircbotx.User
Get all channels user has Owner status in.
getChannelsSuperOpIn() - Method in class org.pircbotx.User
Get all channels user has Super Operator status in.
getChannelsVoiceIn() - Method in class org.pircbotx.User
Get all channels user has Voice status in.
getChannelTypes() - Method in class org.pircbotx.ServerInfo
 
getChatAddress() - Method in class org.pircbotx.hooks.events.IncomingChatRequestEvent
getChatPort() - Method in class org.pircbotx.hooks.events.IncomingChatRequestEvent
Deprecated.
getChatToken() - Method in class org.pircbotx.hooks.events.IncomingChatRequestEvent
getCode() - Method in class org.pircbotx.hooks.events.ServerResponseEvent
The three-digit numerical code for the response.
getCommand() - Method in class org.pircbotx.hooks.events.UnknownEvent
The IRC command that was issued
getConfiguration() - Method in class org.pircbotx.PircBotX
Configuration used for this bot
getConnectedServers() - Method in class org.pircbotx.ServerInfo
 
getConnectExceptions() - Method in class org.pircbotx.hooks.events.ConnectAttemptFailedEvent
 
getConnectionId() - Method in class org.pircbotx.PircBotX
 
getCreateTimestamp() - Method in class org.pircbotx.Channel
Timestamp of when channel was created.
getDaoSnapshot() - Method in class org.pircbotx.hooks.events.DisconnectEvent
getDaoSnapshot() - Method in class org.pircbotx.hooks.events.PartEvent
getDaoSnapshot() - Method in class org.pircbotx.hooks.events.QuitEvent
getDate() - Method in class org.pircbotx.hooks.events.TopicEvent
When the topic was set (milliseconds since the epoch).
getDccAcceptTimeout() - Method in class org.pircbotx.Configuration.Builder
Timeout for user to accept a sent DCC request.
getDccAcceptTimeout() - Method in class org.pircbotx.Configuration
 
getDccHandler() - Method in class org.pircbotx.PircBotX
 
getDccLocalAddress() - Method in class org.pircbotx.Configuration.Builder
The local address to bind DCC connections to, defaults to null (which will be figured out at runtime)
getDccLocalAddress() - Method in class org.pircbotx.Configuration
 
getDccPorts() - Method in class org.pircbotx.Configuration.Builder
Ports to allow DCC incoming connections, recommended to set multiple as DCC connections will be rejected if no free port can be found
getDccPorts() - Method in class org.pircbotx.Configuration
 
getDccPublicAddress() - Method in class org.pircbotx.Configuration.Builder
The public address advertised to other users, defaults to null (which will be figured out at runtime)
getDccPublicAddress() - Method in class org.pircbotx.Configuration
 
getDccResumeAcceptTimeout() - Method in class org.pircbotx.Configuration.Builder
Timeout for a user to accept a resumed DCC request.
getDccResumeAcceptTimeout() - Method in class org.pircbotx.Configuration
 
getDccTransferBufferSize() - Method in class org.pircbotx.Configuration.Builder
Size of the DCC file transfer buffer, default 1024 bytes
getDccTransferBufferSize() - Method in class org.pircbotx.Configuration
 
getDefaultCipherSuites() - Method in class org.pircbotx.UtilSSLSocketFactory
 
getDelay() - Method in class org.pircbotx.delay.AdaptingDelay
 
getDelay() - Method in class org.pircbotx.delay.BinaryBackoffDelay
 
getDelay() - Method in interface org.pircbotx.delay.Delay
 
getDelay() - Method in class org.pircbotx.delay.StaticDelay
 
getDisconnectException() - Method in class org.pircbotx.hooks.events.DisconnectEvent
Exception encountered during disconnection, if any
getEList() - Method in class org.pircbotx.ServerInfo
 
getEnabled() - Method in class org.pircbotx.output.OutputCAP
 
getEnabledCapabilities() - Method in class org.pircbotx.PircBotX
Enabled CAP features
getEncoding() - Method in class org.pircbotx.Configuration.Builder
Charset encoding to use for connection, defaults to Charset.defaultCharset()
getEncoding() - Method in class org.pircbotx.Configuration
 
getEntries() - Method in class org.pircbotx.hooks.events.BanListEvent
 
getEvent() - Method in class org.pircbotx.hooks.managers.ThreadedListenerManager.ManagedFutureTask
 
getExceptBans() - Method in class org.pircbotx.ServerInfo
 
getExceptInvites() - Method in class org.pircbotx.ServerInfo
 
getException() - Method in class org.pircbotx.hooks.events.ExceptionEvent
 
getExecutorPool() - Method in class org.pircbotx.hooks.managers.SequentialListenerManager
The default pool all pooled listeners are executed in
getExtBanList() - Method in class org.pircbotx.ServerInfo
 
getExtBanPrefix() - Method in class org.pircbotx.ServerInfo
 
getExtbanPrefix() - Method in class org.pircbotx.UserHostmask
Extban prefix if in format extban:nick or extban:nick!login@hostmask
getFile() - Method in class org.pircbotx.dcc.FileTransfer
 
getFileSize() - Method in class org.pircbotx.dcc.FileTransfer
 
getFilesize() - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
 
getFinger() - Method in class org.pircbotx.Configuration.Builder
CTCP finger response
getFinger() - Method in class org.pircbotx.Configuration
 
getGeneratedFrom() - Method in class org.pircbotx.snapshot.ChannelSnapshot
 
getGeneratedFrom() - Method in class org.pircbotx.snapshot.UserSnapshot
 
getHalfOps() - Method in class org.pircbotx.Channel
Get all users with Half Operator status in this channel.
getHighestClients() - Method in class org.pircbotx.ServerInfo
 
getHighestConnections() - Method in class org.pircbotx.ServerInfo
 
getHops() - Method in class org.pircbotx.User
The number of hops it takes to this user.
getHostmask() - Method in class org.pircbotx.hooks.events.RemoveChannelBanEvent
The ban hostmask that was set.
getHostmask() - Method in class org.pircbotx.hooks.events.SetChannelBanEvent
getHostmask() - Method in class org.pircbotx.UserHostmask
The full hostmask of the user in extban:user!login@hostname format.
getHostname() - Method in class org.pircbotx.Configuration.ServerEntry
 
getHostname() - Method in class org.pircbotx.hooks.events.WhoisEvent
 
getHostname() - Method in class org.pircbotx.UserHostmask
Hostname of the user (nick!login@hostname).
getId() - Method in class org.pircbotx.hooks.Event
Returns the id of this event generated by incrementing an instance counter
getIdent() - Method in class org.pircbotx.UserHostmask
getIdleSeconds() - Method in class org.pircbotx.hooks.events.WhoisEvent
 
getInputParser() - Method in class org.pircbotx.PircBotX
 
getInvites() - Method in class org.pircbotx.ServerInfo
 
getIsupportRaw() - Method in class org.pircbotx.ServerInfo
Get all supported server options as a map.
getISupportValue(String) - Method in class org.pircbotx.ServerInfo
 
getKey() - Method in class org.pircbotx.hooks.events.RemoveChannelKeyEvent
The key that was in use before the channel key was removed.
getKey() - Method in class org.pircbotx.hooks.events.SetChannelKeyEvent
The new key for the channel.
getKickLength() - Method in class org.pircbotx.ServerInfo
 
getLanguage() - Method in class org.pircbotx.ServerInfo
 
getLevels(C, U) - Method in class org.pircbotx.UserChannelDao
Gets all currently known levels (op/voice/etc) a user holds in the channel.
getLimit() - Method in class org.pircbotx.hooks.events.SetChannelLimitEvent
The maximum number of users that may be in this channel at the same time.
getLine() - Method in class org.pircbotx.hooks.events.UnknownEvent
The raw line that was received from the server.
getLineParsed() - Method in class org.pircbotx.hooks.events.OutputEvent
Raw line split into its individual parts
getList() - Method in class org.pircbotx.hooks.events.ChannelInfoEvent
The results of the channel list.
getListener() - Method in class org.pircbotx.hooks.events.ListenerExceptionEvent
 
getListener() - Method in class org.pircbotx.hooks.managers.ThreadedListenerManager.ManagedFutureTask
 
getListenerManager() - Method in class org.pircbotx.Configuration.Builder
Returns the current ListenerManager in use by this bot.
getListenerManager() - Method in class org.pircbotx.Configuration
 
getListeners() - Method in class org.pircbotx.hooks.managers.BackgroundListenerManager
 
getListeners() - Method in class org.pircbotx.hooks.managers.GenericListenerManager
Deprecated.
 
getListeners() - Method in interface org.pircbotx.hooks.managers.ListenerManager
Gets all listeners that are in this ListenerManager
getListeners() - Method in class org.pircbotx.hooks.managers.SequentialListenerManager
 
getListeners() - Method in class org.pircbotx.hooks.managers.ThreadedListenerManager
 
getLocalAddress() - Method in class org.pircbotx.Configuration.Builder
Address to bind to when connecting to IRC server, default null
getLocalAddress() - Method in class org.pircbotx.Configuration
 
getLocalAddress() - Method in class org.pircbotx.PircBotX
 
getLocale() - Method in class org.pircbotx.Configuration.Builder
Locale to use for connection, defaults to Locale.getDefault()
getLocale() - Method in class org.pircbotx.Configuration
 
getLogin() - Method in class org.pircbotx.Configuration.Builder
The login to be used for the IRC connection (nick!login@host), default PircBotX
getLogin() - Method in class org.pircbotx.Configuration
 
getLogin() - Method in class org.pircbotx.hooks.events.WhoisEvent
 
getLogin() - Method in class org.pircbotx.UserHostmask
Login of the user (nick!login@hostname).
getMaxBans() - Method in class org.pircbotx.ServerInfo
 
getMaxChannels() - Method in class org.pircbotx.ServerInfo
 
getMaxLineLength() - Method in class org.pircbotx.Configuration.Builder
Maximum line length of IRC server, defaults 512 characters
getMaxLineLength() - Method in class org.pircbotx.Configuration
 
getMaxList() - Method in class org.pircbotx.ServerInfo
 
getMaxModes() - Method in class org.pircbotx.ServerInfo
 
getMaxNickLength() - Method in class org.pircbotx.ServerInfo
 
getMaxTargets() - Method in class org.pircbotx.ServerInfo
 
getMessage() - Method in class org.pircbotx.hooks.events.ActionEvent
Returns the action sent by the user.
getMessage() - Method in class org.pircbotx.hooks.events.ExceptionEvent
 
getMessage() - Method in class org.pircbotx.hooks.events.MessageEvent
The actual message sent to the channel.
getMessage() - Method in class org.pircbotx.hooks.events.NoticeEvent
Returns the notice the user sent
getMessage() - Method in class org.pircbotx.hooks.events.PrivateMessageEvent
The actual message.
getMessage() - Method in interface org.pircbotx.hooks.types.GenericMessageEvent
The message the user sent
getMessageDelay() - Method in class org.pircbotx.Configuration.Builder
Millisecond delay between sending messages, default 1000 milliseconds
getMessageDelay() - Method in class org.pircbotx.Configuration
 
getMode() - Method in class org.pircbotx.Channel
Gets the channel mode.
getMode() - Method in class org.pircbotx.ChannelModeHandler
 
getMode() - Method in class org.pircbotx.hooks.events.ModeEvent
The mode that has been set.
getMode() - Method in class org.pircbotx.hooks.events.UserModeEvent
The mode that has been set.
getMode() - Method in class org.pircbotx.output.OutputChannel
 
getMode() - Method in class org.pircbotx.snapshot.ChannelSnapshot
 
getModeParsed() - Method in class org.pircbotx.hooks.events.ModeEvent
 
getMotd() - Method in class org.pircbotx.hooks.events.MotdEvent
The full motd separated by newlines (\n)
getMotd() - Method in class org.pircbotx.ServerInfo
 
getName() - Method in class org.pircbotx.Channel
The name of the channel.
getName() - Method in class org.pircbotx.ChannelListEntry
Channel name
getName() - Method in class org.pircbotx.Configuration.Builder
The nick to be used for the IRC connection (nick!login@host), must not be blank
getName() - Method in class org.pircbotx.Configuration
 
getNetwork() - Method in class org.pircbotx.ServerInfo
 
getNewNick() - Method in class org.pircbotx.hooks.events.NickChangeEvent
The users new nick.
getNick() - Method in class org.pircbotx.hooks.events.UnknownEvent
The nickname (if any) of the originating user
getNick() - Method in class org.pircbotx.hooks.events.WhoisEvent
 
getNick() - Method in class org.pircbotx.PircBotX
Returns the current nick of the bot.
getNick() - Method in class org.pircbotx.UserHostmask
Current nick of the user (nick!login@hostname).
getNickservCustomMessage() - Method in class org.pircbotx.Configuration.Builder
Some irc servers require a custom identify string.
getNickservCustomMessage() - Method in class org.pircbotx.Configuration
 
getNickservNick() - Method in class org.pircbotx.Configuration.Builder
The nick of the nickserv service account, default "nickserv".
getNickservNick() - Method in class org.pircbotx.Configuration
 
getNickservOnSuccess() - Method in class org.pircbotx.Configuration.Builder
Case-insensitive message a user with Configuration.Builder.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
getNickservOnSuccess() - Method in class org.pircbotx.Configuration
 
getNickservPassword() - Method in class org.pircbotx.Configuration.Builder
Password to authenticate against NICKSERV, default null (will not try to identify)
getNickservPassword() - Method in class org.pircbotx.Configuration
 
getNormalUserChannels(U) - Method in class org.pircbotx.UserChannelDao
Gets all currently known channels the user is a part of as a normal user.
getNormalUsers() - Method in class org.pircbotx.Channel
Get all users that don't have any special status in this channel.
getNormalUsers(C) - Method in class org.pircbotx.UserChannelDao
Gets all currently known users in a channel who do not hold a UserLevel (op/voice/etc).
getNotice() - Method in class org.pircbotx.hooks.events.NoticeEvent
The notice message.
getOldNick() - Method in class org.pircbotx.hooks.events.NickChangeEvent
The users old nick.
getOldTopic() - Method in class org.pircbotx.hooks.events.TopicEvent
If known, the old topic of the channel before it was changed.
getOps() - Method in class org.pircbotx.Channel
Get all opped users in this channel.
getOurReason() - Method in exception org.pircbotx.exception.DccException
 
getOutgoingQueueSize() - Method in class org.pircbotx.output.OutputRaw
Gets the number of lines currently waiting in the outgoing message Queue.
getOwners() - Method in class org.pircbotx.Channel
Get all users with Owner status in this channel.
getParsedLine() - Method in class org.pircbotx.hooks.events.UnknownEvent
The parsed line
getParsedResponse() - Method in class org.pircbotx.hooks.events.ServerResponseEvent
Parsed raw line.
getPingValue() - Method in class org.pircbotx.hooks.events.PingEvent
The value that was supplied as an argument to the PING command.
getPort() - Method in class org.pircbotx.Configuration.ServerEntry
 
getPort() - Method in class org.pircbotx.hooks.events.IncomingChatRequestEvent
 
getPort() - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
 
getPort() - Method in interface org.pircbotx.hooks.types.GenericDCCEvent
 
getPrefixes() - Method in class org.pircbotx.ServerInfo
 
getRawFilename() - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
 
getRawLine() - Method in class org.pircbotx.hooks.events.OutputEvent
 
getRawLine() - Method in class org.pircbotx.hooks.events.ServerResponseEvent
The raw line of the response
getRealDccLocalAddress(InetAddress) - Method in class org.pircbotx.dcc.DccHandler
getRealDccLocalAddress() - Method in class org.pircbotx.dcc.DccHandler
 
getRealDccPublicAddress() - Method in class org.pircbotx.dcc.DccHandler
Try to get a real InetAddress in this order: Configuration.getDccPublicAddress() DccHandler.getRealDccLocalAddress()
getRealDccPublicAddress(ServerSocket) - Method in class org.pircbotx.dcc.DccHandler
Try to get a real InetAddress in this order: Configuration.getDccPublicAddress() The given ServerSocket's address
getRealName() - Method in class org.pircbotx.Configuration.Builder
The realName/fullname used for WHOIS info, defaults to version
getRealName() - Method in class org.pircbotx.Configuration
 
getRealname() - Method in class org.pircbotx.hooks.events.WhoisEvent
 
getRealName() - Method in class org.pircbotx.User
Realname/fullname of the user.
getReason() - Method in exception org.pircbotx.exception.DaoException
 
getReason() - Method in class org.pircbotx.hooks.events.KickEvent
The reason given by the user who performed the kick.
getReason() - Method in class org.pircbotx.hooks.events.PartEvent
The reason for leaving the channel.
getReason() - Method in class org.pircbotx.hooks.events.QuitEvent
The reason the user quit from the server.
getRecipient() - Method in class org.pircbotx.hooks.events.BanListEvent.Entry
 
getRecipient() - Method in class org.pircbotx.hooks.events.HalfOpEvent
The user that received the half-op
getRecipient() - Method in class org.pircbotx.hooks.events.KickEvent
The unfortunate recipient of the kick.
getRecipient() - Method in class org.pircbotx.hooks.events.OpEvent
The user that received the Operator status
getRecipient() - Method in class org.pircbotx.hooks.events.OwnerEvent
The user that received the owner status.
getRecipient() - Method in class org.pircbotx.hooks.events.SuperOpEvent
The nick of the user that got 'voiced'.
getRecipient() - Method in class org.pircbotx.hooks.events.UserModeEvent
The user that the mode operation applies to.
getRecipient() - Method in class org.pircbotx.hooks.events.VoiceEvent
The nick of the user that got 'voiced'.
getRecipient() - Method in interface org.pircbotx.hooks.types.GenericUserModeEvent
The recipient user that this event applies to.
getRecipientHostmask() - Method in class org.pircbotx.hooks.events.HalfOpEvent
The user hostmask that received the half-op
getRecipientHostmask() - Method in class org.pircbotx.hooks.events.KickEvent
The unfortunate recipient hostmask of the kick.
getRecipientHostmask() - Method in class org.pircbotx.hooks.events.OpEvent
The user hostmask that received the Operator status
getRecipientHostmask() - Method in class org.pircbotx.hooks.events.OwnerEvent
The user hostmask that received the owner status.
getRecipientHostmask() - Method in class org.pircbotx.hooks.events.SuperOpEvent
The nick of the user that got 'voiced'.
getRecipientHostmask() - Method in class org.pircbotx.hooks.events.UserModeEvent
The user hostmask that the mode operation applies to.
getRecipientHostmask() - Method in class org.pircbotx.hooks.events.VoiceEvent
The user hostmask that got 'voiced'
getRecipientHostmask() - Method in interface org.pircbotx.hooks.types.GenericUserModeEvent
The recipient user hostmask that this event applies to.
getRegisteredAs() - Method in class org.pircbotx.hooks.events.WhoisEvent
If registered, the users nickserv account or if the server doesn't send the account an empty string, or if the user isn't registered at all, null.
getRemainingAttempts() - Method in class org.pircbotx.hooks.events.ConnectAttemptFailedEvent
 
getResponse() - Method in class org.pircbotx.hooks.events.ServerPingEvent
The response that should be given back in your PONG.
getSafeFilename() - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
 
getSequentialThreadFactory() - Method in class org.pircbotx.hooks.managers.SequentialListenerManager
Creates threads used in sequential listeners
getServer() - Method in class org.pircbotx.hooks.events.WhoisEvent
 
getServer() - Method in class org.pircbotx.User
The exact server that this user is joined to.
getServerHostname() - Method in class org.pircbotx.PircBotX
 
getServerInfo() - Method in class org.pircbotx.hooks.events.WhoisEvent
 
getServerInfo() - Method in class org.pircbotx.PircBotX
 
getServerName() - Method in class org.pircbotx.ServerInfo
 
getServerPassword() - Method in class org.pircbotx.Configuration.Builder
Password for IRC server, default null
getServerPassword() - Method in class org.pircbotx.Configuration
 
getServerPort() - Method in class org.pircbotx.PircBotX
 
getServers() - Method in class org.pircbotx.Configuration.Builder
List of servers to connect to, easily add with the addServer methods
getServers() - Method in class org.pircbotx.Configuration
 
getServerUsers() - Method in class org.pircbotx.ServerInfo
 
getServerVersion() - Method in class org.pircbotx.ServerInfo
 
getSignOnTime() - Method in class org.pircbotx.hooks.events.WhoisEvent
 
getSilence() - Method in class org.pircbotx.ServerInfo
 
getSocket() - Method in class org.pircbotx.dcc.Chat
 
getSocketConnectTimeout() - Method in class org.pircbotx.Configuration.Builder
 
getSocketConnectTimeout() - Method in class org.pircbotx.Configuration
 
getSocketFactory() - Method in class org.pircbotx.Configuration.Builder
Socket factory for connections, defaults to SocketFactory.getDefault()
getSocketFactory() - Method in class org.pircbotx.Configuration
 
getSocketTimeout() - Method in class org.pircbotx.Configuration.Builder
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)
getSocketTimeout() - Method in class org.pircbotx.Configuration
 
getSource() - Method in class org.pircbotx.hooks.events.BanListEvent.Entry
 
getSourceEvent() - Method in class org.pircbotx.hooks.events.ListenerExceptionEvent
 
getSslSocketFactory() - Method in class org.pircbotx.cap.TLSCapHandler
 
getStandard() - Method in class org.pircbotx.ServerInfo
 
getStartPosition() - Method in class org.pircbotx.dcc.FileTransfer
 
getState() - Method in class org.pircbotx.dcc.FileTransfer
 
getState() - Method in class org.pircbotx.PircBotX
 
getStatusMessage() - Method in class org.pircbotx.ServerInfo
 
getSuperOps() - Method in class org.pircbotx.Channel
Get all users with Super Operator status in this channel.
getSupported() - Method in class org.pircbotx.output.OutputCAP
 
getSupportedCipherSuites() - Method in class org.pircbotx.UtilSSLSocketFactory
 
getSymbol() - Method in enum org.pircbotx.UserLevel
 
getSymbols() - Static method in enum org.pircbotx.UserLevel
Combines all UserLevel's symbols into a String
getTags() - Method in class org.pircbotx.hooks.events.ActionEvent
The IrcV3 tags
getTags() - Method in class org.pircbotx.hooks.events.MessageEvent
The IrcV3 tags
getTags() - Method in class org.pircbotx.hooks.events.NoticeEvent
The IrcV3 tags
getTags() - Method in class org.pircbotx.hooks.events.PrivateMessageEvent
The IrcV3 tags
getTags() - Method in class org.pircbotx.hooks.events.UnknownEvent
The IRCv3 tags (if any)
getTarget() - Method in class org.pircbotx.hooks.events.UnknownEvent
The target of the event
getTime() - Method in class org.pircbotx.hooks.events.BanListEvent.Entry
 
getTimestamp() - Method in class org.pircbotx.hooks.Event
Returns the millisecond when the event was created.
getTimestamp() - Method in interface org.pircbotx.hooks.types.GenericEvent
The timestamp of when the event was created
getToken() - Method in class org.pircbotx.hooks.events.IncomingChatRequestEvent
 
getToken() - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
 
getToken() - Method in interface org.pircbotx.hooks.types.GenericDCCEvent
 
getTopic() - Method in class org.pircbotx.Channel
The current channel topic
getTopic() - Method in class org.pircbotx.ChannelListEntry
The current channel topic
getTopic() - Method in class org.pircbotx.hooks.events.TopicEvent
The topic for the channel.
getTopicLength() - Method in class org.pircbotx.ServerInfo
 
getTopicSetter() - Method in class org.pircbotx.Channel
Get the user that set the topic.
getTopicTimestamp() - Method in class org.pircbotx.Channel
Timestamp of when the topic was created.
getTotalChannelsFormed() - Method in class org.pircbotx.ServerInfo
 
getTotalInvisibleUsers() - Method in class org.pircbotx.ServerInfo
 
getTotalOperatorsOnline() - Method in class org.pircbotx.ServerInfo
 
getTotalServers() - Method in class org.pircbotx.ServerInfo
 
getTotalUnknownConnections() - Method in class org.pircbotx.ServerInfo
 
getTotalUsers() - Method in class org.pircbotx.ServerInfo
 
getTransferToken() - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
getUsedNick() - Method in class org.pircbotx.hooks.events.NickAlreadyInUseEvent
The nick already in use.
getUser() - Method in class org.pircbotx.dcc.Chat
 
getUser() - Method in class org.pircbotx.dcc.FileTransfer
 
getUser() - Method in exception org.pircbotx.exception.DccException
 
getUser() - Method in class org.pircbotx.hooks.events.ActionEvent
The user that sent the action.
getUser() - Method in class org.pircbotx.hooks.events.FingerEvent
The user that sent the FINGER request.
getUser() - Method in class org.pircbotx.hooks.events.HalfOpEvent
The user that performed the mode change.
getUser() - Method in class org.pircbotx.hooks.events.IncomingChatRequestEvent
 
getUser() - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
 
getUser() - Method in class org.pircbotx.hooks.events.InviteEvent
The user that sent the invite.
getUser() - Method in class org.pircbotx.hooks.events.JoinEvent
The user who joined the channel.
getUser() - Method in class org.pircbotx.hooks.events.KickEvent
The user who performed the kick.
getUser() - Method in class org.pircbotx.hooks.events.MessageEvent
The user who sent the message.
getUser() - Method in class org.pircbotx.hooks.events.ModeEvent
The user that set the mode.
getUser() - Method in class org.pircbotx.hooks.events.NickChangeEvent
The user that changed their nick.
getUser() - Method in class org.pircbotx.hooks.events.NoticeEvent
The user that sent the notice.
getUser() - Method in class org.pircbotx.hooks.events.OpEvent
The user that performed the mode change
getUser() - Method in class org.pircbotx.hooks.events.OwnerEvent
The user that performed the mode change.
getUser() - Method in class org.pircbotx.hooks.events.PartEvent
Snapshot of the user as of before the user parted.
getUser() - Method in class org.pircbotx.hooks.events.PingEvent
The user that sent the PING request.
getUser() - Method in class org.pircbotx.hooks.events.PrivateMessageEvent
The user who sent the private message.
getUser() - Method in class org.pircbotx.hooks.events.QuitEvent
Snapshot of the user as of before the user quit.
getUser() - Method in class org.pircbotx.hooks.events.RemoveChannelBanEvent
The user that performed the mode change.
getUser() - Method in class org.pircbotx.hooks.events.RemoveChannelKeyEvent
 
getUser() - Method in class org.pircbotx.hooks.events.RemoveChannelLimitEvent
 
getUser() - Method in class org.pircbotx.hooks.events.RemoveInviteOnlyEvent
 
getUser() - Method in class org.pircbotx.hooks.events.RemoveModeratedEvent
 
getUser() - Method in class org.pircbotx.hooks.events.RemoveNoExternalMessagesEvent
 
getUser() - Method in class org.pircbotx.hooks.events.RemovePrivateEvent
 
getUser() - Method in class org.pircbotx.hooks.events.RemoveSecretEvent
 
getUser() - Method in class org.pircbotx.hooks.events.RemoveTopicProtectionEvent
 
getUser() - Method in class org.pircbotx.hooks.events.SetChannelBanEvent
 
getUser() - Method in class org.pircbotx.hooks.events.SetChannelKeyEvent
 
getUser() - Method in class org.pircbotx.hooks.events.SetChannelLimitEvent
 
getUser() - Method in class org.pircbotx.hooks.events.SetInviteOnlyEvent
 
getUser() - Method in class org.pircbotx.hooks.events.SetModeratedEvent
 
getUser() - Method in class org.pircbotx.hooks.events.SetNoExternalMessagesEvent
 
getUser() - Method in class org.pircbotx.hooks.events.SetPrivateEvent
 
getUser() - Method in class org.pircbotx.hooks.events.SetSecretEvent
 
getUser() - Method in class org.pircbotx.hooks.events.SetTopicProtectionEvent
The user that performed the mode change.
getUser() - Method in class org.pircbotx.hooks.events.SuperOpEvent
The user that performed the mode change.
getUser() - Method in class org.pircbotx.hooks.events.TimeEvent
The user that sent the TIME request.
getUser() - Method in class org.pircbotx.hooks.events.TopicEvent
The user that set the topic.
getUser() - Method in class org.pircbotx.hooks.events.UserModeEvent
The user that set the mode.
getUser() - Method in class org.pircbotx.hooks.events.VersionEvent
 
getUser() - Method in class org.pircbotx.hooks.events.VoiceEvent
The user that performed the mode change.
getUser() - Method in interface org.pircbotx.hooks.types.GenericUserEvent
The source user that generated the event.
getUser(String) - Method in class org.pircbotx.UserChannelDao
Lookup user by nick, throwing a DaoException if not found
getUser(UserHostmask) - Method in class org.pircbotx.UserChannelDao
Lookup user by UserHostmask, throwing a DaoException if not found
getUserBot() - Method in class org.pircbotx.PircBotX
Gets the bots own user object.
getUserBot() - Method in class org.pircbotx.snapshot.UserChannelDaoSnapshot
 
getUserBot() - Method in class org.pircbotx.UserChannelDao
Gets the bots own user object.
getUserChannelDao() - Method in class org.pircbotx.PircBotX
User-Channel mapper
getUserChannelDaoSnapshot() - Method in class org.pircbotx.hooks.events.DisconnectEvent
 
getUserChannelDaoSnapshot() - Method in class org.pircbotx.hooks.events.PartEvent
 
getUserChannelDaoSnapshot() - Method in class org.pircbotx.hooks.events.QuitEvent
 
getUserChannelDaoSnapshot() - Method in interface org.pircbotx.hooks.types.GenericSnapshotEvent
Snapshot of the UserChannelDao data before the event.
getUserHostmask() - Method in class org.pircbotx.hooks.events.ActionEvent
The user hostmask that sent the action.
getUserHostmask() - Method in class org.pircbotx.hooks.events.FingerEvent
The user hostmask that sent the FINGER request.
getUserHostmask() - Method in class org.pircbotx.hooks.events.HalfOpEvent
The user hostmask that performed the mode change.
getUserHostmask() - Method in class org.pircbotx.hooks.events.IncomingChatRequestEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.InviteEvent
The user hostmask that sent the invite.
getUserHostmask() - Method in class org.pircbotx.hooks.events.JoinEvent
The user hostmask who joined the channel.
getUserHostmask() - Method in class org.pircbotx.hooks.events.KickEvent
The user hostmask that performed the kick.
getUserHostmask() - Method in class org.pircbotx.hooks.events.MessageEvent
The user hostmask who sent the message.
getUserHostmask() - Method in class org.pircbotx.hooks.events.ModeEvent
The user that set the mode.
getUserHostmask() - Method in class org.pircbotx.hooks.events.NickChangeEvent
The user that changed their nick.
getUserHostmask() - Method in class org.pircbotx.hooks.events.NoticeEvent
The user hostmask that sent the hostmask.
getUserHostmask() - Method in class org.pircbotx.hooks.events.OpEvent
The user hostmask that performed the mode change
getUserHostmask() - Method in class org.pircbotx.hooks.events.OwnerEvent
The user hostmask that performed the mode change.
getUserHostmask() - Method in class org.pircbotx.hooks.events.PartEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.PingEvent
The user that sent the PING request.
getUserHostmask() - Method in class org.pircbotx.hooks.events.PrivateMessageEvent
The user hostmask who sent the private message.
getUserHostmask() - Method in class org.pircbotx.hooks.events.QuitEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.RemoveChannelBanEvent
The user that performed the mode change.
getUserHostmask() - Method in class org.pircbotx.hooks.events.RemoveChannelKeyEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.RemoveChannelLimitEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.RemoveInviteOnlyEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.RemoveModeratedEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.RemoveNoExternalMessagesEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.RemovePrivateEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.RemoveSecretEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.RemoveTopicProtectionEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.SetChannelBanEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.SetChannelKeyEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.SetChannelLimitEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.SetInviteOnlyEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.SetModeratedEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.SetNoExternalMessagesEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.SetPrivateEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.SetSecretEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.SetTopicProtectionEvent
The user that performed the mode change.
getUserHostmask() - Method in class org.pircbotx.hooks.events.SuperOpEvent
The user that performed the mode change.
getUserHostmask() - Method in class org.pircbotx.hooks.events.TimeEvent
The user that sent the TIME request.
getUserHostmask() - Method in class org.pircbotx.hooks.events.UserModeEvent
The user hostmask that set the mode.
getUserHostmask() - Method in class org.pircbotx.hooks.events.VersionEvent
 
getUserHostmask() - Method in class org.pircbotx.hooks.events.VoiceEvent
The user hostmask that performed the mode change.
getUserHostmask() - Method in interface org.pircbotx.hooks.types.GenericUserEvent
The source user hostmask that generated the event.
getUserId() - Method in class org.pircbotx.User
 
getUserLevelPrefixes() - Method in class org.pircbotx.Configuration.Builder
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 +@%&~!
getUserLevelPrefixes() - Method in class org.pircbotx.Configuration
 
getUserLevels(User) - Method in class org.pircbotx.Channel
Get all levels the user holds in this channel.
getUserLevels(Channel) - Method in class org.pircbotx.User
Get all the levels this user holds in the channel.
getUserModes() - Method in class org.pircbotx.ServerInfo
 
getUsers() - Method in class org.pircbotx.Channel
Get all users in this channel.
getUsers() - Method in class org.pircbotx.ChannelListEntry
Number of users currently in the channel
getUsers() - Method in class org.pircbotx.hooks.events.UserListEvent
An immutable Set of Users belonging to this channel.
getUsers(C, UserLevel) - Method in class org.pircbotx.UserChannelDao
Gets all currently known users in a channel that hold the specified UserLevel.
getUsers(C) - Method in class org.pircbotx.UserChannelDao
Get all currently known users in a channel
getUsers(C) - Method in class org.pircbotx.UserChannelMap
 
getUsersNicks() - Method in class org.pircbotx.Channel
Get all the user's nicks in this channel
getV3Tags() - Method in class org.pircbotx.hooks.events.ActionEvent
getV3Tags() - Method in class org.pircbotx.hooks.events.MessageEvent
getV3Tags() - Method in class org.pircbotx.hooks.events.NoticeEvent
getV3Tags() - Method in class org.pircbotx.hooks.events.PrivateMessageEvent
getV3Tags() - Method in interface org.pircbotx.hooks.types.GenericMessageEvent
Accessor for the IRCv3 Message tags
getVersion() - Method in class org.pircbotx.Configuration.Builder
CTCP version response.
getVersion() - Method in class org.pircbotx.Configuration
 
getVoices() - Method in class org.pircbotx.Channel
Get all voiced users in this channel.
getWatchMax() - Method in class org.pircbotx.ServerInfo
 
getWebIrcAddress() - Method in class org.pircbotx.Configuration.Builder
IP address of WEBIRC connection, must be set if WEBIRC is enabled
getWebIrcAddress() - Method in class org.pircbotx.Configuration
 
getWebIrcHostname() - Method in class org.pircbotx.Configuration.Builder
Hostname of WEBIRC connection, must not be blank if WEBIRC is enabled
getWebIrcHostname() - Method in class org.pircbotx.Configuration
 
getWebIrcPassword() - Method in class org.pircbotx.Configuration.Builder
Password of WEBIRC connection, must not be blank if WEBIRC is enabled
getWebIrcPassword() - Method in class org.pircbotx.Configuration
 
getWebIrcUsername() - Method in class org.pircbotx.Configuration.Builder
Username of WEBIRC connection, must not be blank if WEBIRC is enabled
getWebIrcUsername() - Method in class org.pircbotx.Configuration
 
GREEN - Static variable in class org.pircbotx.Colors
Green coloured text.

H

halfOp(UserHostmask) - Method in class org.pircbotx.output.OutputChannel
Grants owner privileges to a user on a channel.
HalfOpEvent - Class in org.pircbotx.hooks.events
Called when a user (possibly us) gets halfop status granted in a channel.
HalfOpEvent(PircBotX, Channel, UserHostmask, User, UserHostmask, User, boolean) - Constructor for class org.pircbotx.hooks.events.HalfOpEvent
 
handleACK(PircBotX, ImmutableList<String>) - Method in interface org.pircbotx.cap.CapHandler
 
handleACK(PircBotX, ImmutableList<String>) - Method in class org.pircbotx.cap.EnableCapHandler
 
handleACK(PircBotX, ImmutableList<String>) - Method in class org.pircbotx.cap.SASLCapHandler
 
handleACK(PircBotX, ImmutableList<String>) - Method in class org.pircbotx.cap.TLSCapHandler
 
handleEvent(Event) - Method in class org.pircbotx.hooks.managers.SequentialListenerManager.InlineListenerExecutor
 
handleEvent(Event) - Method in interface org.pircbotx.hooks.managers.SequentialListenerManager.ListenerExecutor
 
handleEvent(Event) - Method in class org.pircbotx.hooks.managers.SequentialListenerManager.PooledListenerExecutor
 
handleLine(String) - Method in class org.pircbotx.InputParser
This method handles events when any line of text arrives from the server, then dispatching the appropriate event.
handleLS(PircBotX, ImmutableList<String>) - Method in interface org.pircbotx.cap.CapHandler
 
handleLS(PircBotX, ImmutableList<String>) - Method in class org.pircbotx.cap.EnableCapHandler
 
handleMode(PircBotX, Channel, UserHostmask, User, PeekingIterator<String>, boolean, boolean) - Method in class org.pircbotx.ChannelModeHandler
 
handleNAK(PircBotX, ImmutableList<String>) - Method in interface org.pircbotx.cap.CapHandler
 
handleNAK(PircBotX, ImmutableList<String>) - Method in class org.pircbotx.cap.EnableCapHandler
 
handleNextConnection(InetSocketAddress, String) - Method in class org.pircbotx.IdentServer
Wait for and process the next connection.
handleUnknown(PircBotX, String) - Method in interface org.pircbotx.cap.CapHandler
 
handleUnknown(PircBotX, String) - Method in class org.pircbotx.cap.EnableCapHandler
 
handleUnknown(PircBotX, String) - Method in class org.pircbotx.cap.SASLCapHandler
 
handleUnknown(PircBotX, String) - Method in class org.pircbotx.cap.TLSCapHandler
 
hashCode() - Method in class org.pircbotx.Channel
 
hashCode() - Method in class org.pircbotx.ChannelListEntry
 
hashCode() - Method in class org.pircbotx.ChannelModeHandler
 
hashCode() - Method in class org.pircbotx.Configuration.Builder
 
hashCode() - Method in class org.pircbotx.Configuration
 
hashCode() - Method in class org.pircbotx.Configuration.ServerEntry
 
hashCode() - Method in class org.pircbotx.hooks.Event
 
hashCode() - Method in class org.pircbotx.hooks.events.ActionEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.BanListEvent.Entry
 
hashCode() - Method in class org.pircbotx.hooks.events.BanListEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.ChannelInfoEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.ConnectAttemptFailedEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.ConnectEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.DisconnectEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.ExceptionEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.FingerEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.HalfOpEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.IncomingChatRequestEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.InviteEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.JoinEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.KickEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.ListenerExceptionEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.MessageEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.ModeEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.MotdEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.NickAlreadyInUseEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.NickChangeEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.NoticeEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.OpEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.OutputEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.OwnerEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.PartEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.PingEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.PrivateMessageEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.QuitEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.RemoveChannelBanEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.RemoveChannelKeyEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.RemoveChannelLimitEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.RemoveInviteOnlyEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.RemoveModeratedEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.RemoveNoExternalMessagesEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.RemovePrivateEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.RemoveSecretEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.RemoveTopicProtectionEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.ServerPingEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.ServerResponseEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.SetChannelBanEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.SetChannelKeyEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.SetChannelLimitEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.SetInviteOnlyEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.SetModeratedEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.SetNoExternalMessagesEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.SetPrivateEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.SetSecretEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.SetTopicProtectionEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.SocketConnectEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.SuperOpEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.TimeEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.TopicEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.UnknownEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.UserListEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.UserModeEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.VersionEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.VoiceEvent
 
hashCode() - Method in class org.pircbotx.hooks.events.WhoisEvent
 
hashCode() - Method in class org.pircbotx.PircBotX
 
hashCode() - Method in class org.pircbotx.ServerInfo
 
hashCode() - Method in class org.pircbotx.snapshot.UserSnapshot
 
hashCode() - Method in class org.pircbotx.User
Hash code generated from UUID
hashCode() - Method in class org.pircbotx.UserHostmask
 
hashCode() - Method in class org.pircbotx.UtilSSLSocketFactory
 
hasTopicProtection() - Method in class org.pircbotx.Channel
Check if the channel has topic protection (+t) set.
hasVoice(User) - Method in class org.pircbotx.Channel
Checks if the given user has Voice in this channel.
hasVoice() - Method in class org.pircbotx.hooks.events.VoiceEvent
If the voice was given or removed.
hostname(String) - Method in class org.pircbotx.hooks.events.WhoisEvent.Builder
 

I

identify(String) - Method in class org.pircbotx.output.OutputIRC
Identify the bot with NickServ, supplying the appropriate password.
IdentServer - Class in org.pircbotx
A simple IdentServer (also know as "The Identification Protocol").
idleSeconds(long) - Method in class org.pircbotx.hooks.events.WhoisEvent.Builder
 
IncomingChatRequestEvent - Class in org.pircbotx.hooks.events
This event will be dispatched whenever a DCC Chat request is received.
IncomingChatRequestEvent(PircBotX, UserHostmask, User, InetAddress, int, String, boolean) - Constructor for class org.pircbotx.hooks.events.IncomingChatRequestEvent
 
IncomingFileTransferEvent - Class in org.pircbotx.hooks.events
This event is dispatched whenever a DCC SEND request is sent to the PircBotX.
IncomingFileTransferEvent(PircBotX, UserHostmask, User, String, String, InetAddress, int, long, String, boolean) - Constructor for class org.pircbotx.hooks.events.IncomingFileTransferEvent
 
InlineListenerExecutor(AbstractListenerManager, Listener) - Constructor for class org.pircbotx.hooks.managers.SequentialListenerManager.InlineListenerExecutor
 
INPUT_CHAT_MARKER - Static variable in class org.pircbotx.dcc.Chat
 
INPUT_MARKER - Static variable in class org.pircbotx.InputParser
 
InputParser - Class in org.pircbotx
Parse received input from IRC server.
InputParser(PircBotX) - Constructor for class org.pircbotx.InputParser
 
InputParser(Configuration, PircBotX) - Constructor for class org.pircbotx.InputParser
 
invite(Channel) - Method in class org.pircbotx.output.OutputChannel
Send an invite for this channel to another channel.
invite(UserHostmask) - Method in class org.pircbotx.output.OutputChannel
Send an invite from this channel to a user
invite(String) - Method in class org.pircbotx.output.OutputChannel
Send an invite from this channel to a channel or user.
invite(String, String) - Method in class org.pircbotx.output.OutputIRC
Sends an invitation to join a channel.
invite(String) - Method in class org.pircbotx.output.OutputUser
Send an invite to the serverUser for more information
invite(Channel) - Method in class org.pircbotx.output.OutputUser
Send an invite to the serverUser.
InviteEvent - Class in org.pircbotx.hooks.events
Called when we are invited to a channel by a user.
InviteEvent(PircBotX, UserHostmask, User, String) - Constructor for class org.pircbotx.hooks.events.InviteEvent
 
IrcException - Exception in org.pircbotx.exception
A fatal IRC error.
IrcException(IrcException.Reason, String) - Constructor for exception org.pircbotx.exception.IrcException
Constructs a new IrcException.
IrcException.Reason - Enum in org.pircbotx.exception
 
ircOp(boolean) - Method in class org.pircbotx.hooks.events.WhoisEvent.Builder
 
isAccept() - Method in class org.pircbotx.ServerInfo
 
isAutoNickChange() - Method in class org.pircbotx.Configuration.Builder
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
isAutoNickChange() - Method in class org.pircbotx.Configuration
 
isAutoNickChange() - Method in class org.pircbotx.hooks.events.NickAlreadyInUseEvent
If auto nick change is enabled
isAutoReconnect() - Method in class org.pircbotx.Configuration.Builder
Enable or disable automatic reconnecting, default false.
isAutoReconnect() - Method in class org.pircbotx.Configuration
 
isAutoSplitMessage() - Method in class org.pircbotx.Configuration.Builder
Enable or disable automatic message splitting to fit Configuration.Builder.getMaxLineLength() to prevent the IRC server from possibly truncating or rejecting the line, default true.
isAutoSplitMessage() - Method in class org.pircbotx.Configuration
 
isAway() - Method in class org.pircbotx.User
 
isCallerID() - Method in class org.pircbotx.ServerInfo
 
isCapEnabled() - Method in class org.pircbotx.Configuration.Builder
Enable or disable CAP handling, defaults true.
isCapEnabled() - Method in class org.pircbotx.Configuration
 
isChanged() - Method in class org.pircbotx.hooks.events.TopicEvent
True if the topic has just been changed, false if the topic was already there.
isChannelListRunning() - Method in class org.pircbotx.InputParser
 
isChannelPrivate() - Method in class org.pircbotx.Channel
Private (+p) status
isCNoticeExists() - Method in class org.pircbotx.ServerInfo
 
isComplete() - Method in class org.pircbotx.hooks.events.UserListEvent
True if from a WHO response meaning login, hostmask, mode, etc was given, false if from a NAMES response meaning only nick was given
isConnected() - Method in class org.pircbotx.PircBotX
Returns whether or not the PircBotX is currently connected to a server.
isCPrivMsgExists() - Method in class org.pircbotx.ServerInfo
 
isDccFilenameQuotes() - Method in class org.pircbotx.Configuration.Builder
If true sends filenames in quotes, otherwise uses underscores, default enabled.
isDccFilenameQuotes() - Method in class org.pircbotx.Configuration
 
isDccPassiveRequest() - Method in class org.pircbotx.Configuration.Builder
Send DCC requests as passive/reverse requests if not specified otherwise, default false
isDccPassiveRequest() - Method in class org.pircbotx.Configuration
 
isDiffieHellmanDisabled() - Method in class org.pircbotx.UtilSSLSocketFactory
 
isExists() - Method in class org.pircbotx.hooks.events.WhoisEvent
 
isFinished() - Method in class org.pircbotx.dcc.Chat
 
isFinished() - Method in class org.pircbotx.dcc.FileTransfer
Is the transfer finished?
isForcedNickChanges() - Method in class org.pircbotx.ServerInfo
 
isFounder() - Method in class org.pircbotx.hooks.events.OwnerEvent
Deprecated.
Use isOwner, this method being called isFounder is a bug. Will be removed in future versions
isHalfOp(User) - Method in class org.pircbotx.Channel
Checks if the given user is a Half Operator in this channel.
isHalfOp() - Method in class org.pircbotx.hooks.events.HalfOpEvent
If the half-op status was given or removed.
isIdentServerEnabled() - Method in class org.pircbotx.Configuration.Builder
Enable or disable use of an existing IdentServer, default false.
isIdentServerEnabled() - Method in class org.pircbotx.Configuration
 
isInviteOnly() - Method in class org.pircbotx.Channel
Invite only (+i) status
isIrcOp() - Method in class org.pircbotx.hooks.events.WhoisEvent
 
isIrcop() - Method in class org.pircbotx.User
Users IRCop status
isKnockExists() - Method in class org.pircbotx.ServerInfo
 
isModerated() - Method in class org.pircbotx.Channel
Moderated (+m) status
isNickservDelayJoin() - Method in class org.pircbotx.Configuration.Builder
Delay joining channels until were identified to nickserv, default false
isNickservDelayJoin() - Method in class org.pircbotx.Configuration
 
isNickservIdentified() - Method in class org.pircbotx.PircBotX
 
isNoExternalMessages() - Method in class org.pircbotx.Channel
No external messages (+n) status
isNoQuit() - Method in class org.pircbotx.ServerInfo
 
isOnJoinWhoEnabled() - Method in class org.pircbotx.Configuration.Builder
Enable or disable sending "WHO #channel" upon joining a channel and rely only on the NAMES response
isOnJoinWhoEnabled() - Method in class org.pircbotx.Configuration
 
isOp(User) - Method in class org.pircbotx.Channel
Checks if the given user is an Operator in this channel
isOp() - Method in class org.pircbotx.hooks.events.OpEvent
If the operator status was given or removed.
isOwner(User) - Method in class org.pircbotx.Channel
Checks if the given user is an Owner in this channel.
isOwner() - Method in class org.pircbotx.hooks.events.OwnerEvent
If the owner status was given or removed
isPassive() - Method in class org.pircbotx.hooks.events.IncomingChatRequestEvent
 
isPassive() - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
 
isPassive() - Method in interface org.pircbotx.hooks.types.GenericDCCEvent
 
isPenalty() - Method in class org.pircbotx.ServerInfo
 
isRegistered() - Method in class org.pircbotx.hooks.events.WhoisEvent
Check if user is registered
isRFC2812() - Method in class org.pircbotx.ServerInfo
 
isSafeList() - Method in class org.pircbotx.ServerInfo
 
isSecret() - Method in class org.pircbotx.Channel
Secret (+s) status
isSecureConnection() - Method in class org.pircbotx.hooks.events.WhoisEvent
 
isShutdownHookEnabled() - Method in class org.pircbotx.Configuration.Builder
Enable or disable creating a JVM shutdown hook which will properly QUIT the IRC server and shutdown the bot, default true
isShutdownHookEnabled() - Method in class org.pircbotx.Configuration
 
isSnapshotsEnabled() - Method in class org.pircbotx.Configuration.Builder
Enable creation of snapshots, default true.
isSnapshotsEnabled() - Method in class org.pircbotx.Configuration
 
isSuperOp(User) - Method in class org.pircbotx.Channel
Checks if the given user is a Super Operator in this channel.
isSuperOp() - Method in class org.pircbotx.hooks.events.SuperOpEvent
If the super-op was given or removed
isTrustingAllCertificates() - Method in class org.pircbotx.UtilSSLSocketFactory
 
isUserIPExists() - Method in class org.pircbotx.ServerInfo
 
isUserModeHideRealHost() - Method in class org.pircbotx.Configuration.Builder
Sets mode +x on the bot, to hide the real hostname, default = false
isUserModeHideRealHost() - Method in class org.pircbotx.Configuration
 
isVChannels() - Method in class org.pircbotx.ServerInfo
 
isVerified() - Method in class org.pircbotx.User
Query the user with WHOIS to determine if they are verified *EXPENSIVE*.
isVoice() - Method in class org.pircbotx.hooks.events.VoiceEvent
Deprecated.
Use the better named hasVoice method. Will be removed in future versions
isWallOps() - Method in class org.pircbotx.ServerInfo
 
isWallVoices() - Method in class org.pircbotx.ServerInfo
 
isWebIrcEnabled() - Method in class org.pircbotx.Configuration.Builder
Enable or disable sending WEBIRC line on connect, default disabled
isWebIrcEnabled() - Method in class org.pircbotx.Configuration
 
isWhoX() - Method in class org.pircbotx.ServerInfo
 
ITALICS - Static variable in class org.pircbotx.Colors
Italicized text.

J

joinChannel(String) - Method in class org.pircbotx.output.OutputIRC
Joins a channel.
joinChannel(String, String) - Method in class org.pircbotx.output.OutputIRC
Joins a channel with a key.
JoinEvent - Class in org.pircbotx.hooks.events
This event is dispatched whenever someone (possibly us) joins a channel which we are on.
JoinEvent(PircBotX, Channel, UserHostmask, User) - Constructor for class org.pircbotx.hooks.events.JoinEvent
 

K

kick(UserHostmask) - Method in class org.pircbotx.output.OutputChannel
Kicks a user from a channel.
kick(UserHostmask, String) - Method in class org.pircbotx.output.OutputChannel
Kicks a user from a channel, giving a reason.
KickEvent - Class in org.pircbotx.hooks.events
This event is dispatched whenever someone (possibly us) is kicked from any of the channels that we are in.
KickEvent(PircBotX, Channel, UserHostmask, User, UserHostmask, User, String) - Constructor for class org.pircbotx.hooks.events.KickEvent
 

L

LIGHT_GRAY - Static variable in class org.pircbotx.Colors
Light gray coloured text.
listChannels() - Method in class org.pircbotx.output.OutputIRC
Issues a request for a list of all channels on the IRC server.
listChannels(String) - Method in class org.pircbotx.output.OutputIRC
Issues a request for a list of all channels on the IRC server.
Listener - Interface in org.pircbotx.hooks
A generic listener to receive events.
ListenerAdapter - Class in org.pircbotx.hooks
Adapter that provides methods to capture each event separately, removing the need to check, cast, and call your custom method for each event you want to capture.
ListenerAdapter() - Constructor for class org.pircbotx.hooks.ListenerAdapter
 
ListenerExceptionEvent - Class in org.pircbotx.hooks.events
Dispatched when a listener throws an Exception.
ListenerExceptionEvent(PircBotX, Exception, String, Listener, Event) - Constructor for class org.pircbotx.hooks.events.ListenerExceptionEvent
 
listenerExists(Listener) - Method in class org.pircbotx.hooks.managers.GenericListenerManager
Deprecated.
 
listenerExists(Listener) - Method in interface org.pircbotx.hooks.managers.ListenerManager
Check if a listener is in this ListenerManager
listenerExists(Listener) - Method in class org.pircbotx.hooks.managers.SequentialListenerManager
 
listenerExists(Listener) - Method in class org.pircbotx.hooks.managers.ThreadedListenerManager
 
ListenerManager - Interface in org.pircbotx.hooks.managers
Track Listener's and handles dispatching events
login(String) - Method in class org.pircbotx.hooks.events.WhoisEvent.Builder
 
lookup(String) - Static method in class org.pircbotx.Colors
Lookup color as a String
LOOKUP_TABLE - Static variable in class org.pircbotx.Colors
Pre-built lookup table by String for all the fields in this class.

M

MAGENTA - Static variable in class org.pircbotx.Colors
Magenta coloured text.
main(String[]) - Static method in class org.pircbotx.dcc.DccHandler
 
main(String[]) - Static method in class org.pircbotx.ReplayServer
 
ManagedFutureTask(Listener, Event, Runnable) - Constructor for class org.pircbotx.hooks.managers.ThreadedListenerManager.ManagedFutureTask
 
message(String) - Method in interface org.pircbotx.output.GenericChannelUserOutput
Send a message to the represented user or channel.
message(String) - Method in class org.pircbotx.output.OutputChannel
Send a message to the channel.
message(UserHostmask, String) - Method in class org.pircbotx.output.OutputChannel
Send a message to the given user in the given channel in this format: user: message.
message(String, String) - Method in class org.pircbotx.output.OutputIRC
Sends a message to a channel or a private message to a user.
message(String) - Method in class org.pircbotx.output.OutputUser
Send a private message to a serverUser.
MessageEvent - Class in org.pircbotx.hooks.events
Used whenever a message is sent to a channel.
MessageEvent(PircBotX, Channel, String, UserHostmask, User, String, ImmutableMap<String, String>) - Constructor for class org.pircbotx.hooks.events.MessageEvent
 
mode(String, String) - Method in class org.pircbotx.output.OutputIRC
 
mode(String) - Method in class org.pircbotx.output.OutputUser
Send usermode
ModeEvent - Class in org.pircbotx.hooks.events
Used when the mode of a channel is set.
ModeEvent(PircBotX, Channel, UserHostmask, User, String, ImmutableList<String>) - Constructor for class org.pircbotx.hooks.events.ModeEvent
 
MotdEvent - Class in org.pircbotx.hooks.events
This event is dispatched when the Motd is finished being sent.
MotdEvent(PircBotX, String) - Constructor for class org.pircbotx.hooks.events.MotdEvent
 
MultiBotManager - Class in org.pircbotx
Manager that makes connecting and running multiple bots an easy, painless process.
MultiBotManager() - Constructor for class org.pircbotx.MultiBotManager
Create MultiBotManager with a cached thread pool.
MultiBotManager(ExecutorService) - Constructor for class org.pircbotx.MultiBotManager
Create MultiBotManager with the specified thread pool.

N

newDefault() - Static method in class org.pircbotx.hooks.managers.SequentialListenerManager
Create with executorPool = Executors.newCachedThreadPool(); sequentialThreadFactory = Executors.defaultThreadFactory();
nick(String) - Method in class org.pircbotx.hooks.events.WhoisEvent.Builder
 
NickAlreadyInUseEvent - Class in org.pircbotx.hooks.events
A nick is already in use error from server.
NickAlreadyInUseEvent(PircBotX, String, String, boolean) - Constructor for class org.pircbotx.hooks.events.NickAlreadyInUseEvent
 
NickChangeEvent - Class in org.pircbotx.hooks.events
This event is dispatched whenever someone (possibly us) changes nick on any of the channels that we are on.
NickChangeEvent(PircBotX, String, String, UserHostmask, User) - Constructor for class org.pircbotx.hooks.events.NickChangeEvent
 
NORMAL - Static variable in class org.pircbotx.Colors
Removes all previously applied color and formatting attributes.
notice(String) - Method in interface org.pircbotx.output.GenericChannelUserOutput
Send a notice to the represented user or channel.
notice(String) - Method in class org.pircbotx.output.OutputChannel
Send a notice to the channel.
notice(String, String) - Method in class org.pircbotx.output.OutputIRC
Sends a notice to the channel or to a user.
notice(String) - Method in class org.pircbotx.output.OutputUser
Send a notice to the serverUser.
NoticeEvent - Class in org.pircbotx.hooks.events
This event is dispatched whenever we receive a notice.
NoticeEvent(PircBotX, UserHostmask, User, Channel, String, String, ImmutableMap<String, String>) - Constructor for class org.pircbotx.hooks.events.NoticeEvent
 

O

OLIVE - Static variable in class org.pircbotx.Colors
Olive coloured text.
onAction(ActionEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onBanList(BanListEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onChannelInfo(ChannelInfoEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onConnect(ConnectEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onConnectAttemptFailed(ConnectAttemptFailedEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onDisconnect(DisconnectEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onEvent(Event) - Method in interface org.pircbotx.hooks.Listener
 
onEvent(Event) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onEvent(Event) - Method in class org.pircbotx.hooks.managers.AbstractListenerManager
 
onEvent(Event) - Method in class org.pircbotx.hooks.managers.BackgroundListenerManager
 
onEvent(Event) - Method in class org.pircbotx.hooks.managers.GenericListenerManager
Deprecated.
 
onEvent(Event) - Method in interface org.pircbotx.hooks.managers.ListenerManager
Sends event to all appropriate listeners.
onEvent(Event) - Method in class org.pircbotx.hooks.managers.SequentialListenerManager
 
onEvent(Event) - Method in class org.pircbotx.hooks.managers.ThreadedListenerManager
 
onEvent(Event) - Method in class org.pircbotx.hooks.TemporaryListener
 
onException(ExceptionEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onFinger(FingerEvent) - Method in class org.pircbotx.hooks.CoreHooks
 
onFinger(FingerEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onGenericChannel(GenericChannelEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onGenericChannelMode(GenericChannelModeEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onGenericChannelModeRecipient(GenericChannelModeRecipientEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onGenericChannelUser(GenericChannelUserEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onGenericCTCP(GenericCTCPEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onGenericDCC(GenericDCCEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onGenericMessage(GenericMessageEvent) - Method in class org.pircbotx.hooks.CoreHooks
 
onGenericMessage(GenericMessageEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onGenericUser(GenericUserEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onGenericUserMode(GenericUserModeEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onHalfOp(HalfOpEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onIncomingChatRequest(IncomingChatRequestEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onIncomingFileTransfer(IncomingFileTransferEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onInvite(InviteEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onJoin(JoinEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onKick(KickEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onListenerException(ListenerExceptionEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onMessage(MessageEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onMode(ModeEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onMotd(MotdEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onNickAlreadyInUse(NickAlreadyInUseEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onNickChange(NickChangeEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onNotice(NoticeEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onOp(OpEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onOutput(OutputEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onOwner(OwnerEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onPart(PartEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onPing(PingEvent) - Method in class org.pircbotx.hooks.CoreHooks
 
onPing(PingEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onPrivateMessage(PrivateMessageEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onQuit(QuitEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onRemoveChannelBan(RemoveChannelBanEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onRemoveChannelKey(RemoveChannelKeyEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onRemoveChannelLimit(RemoveChannelLimitEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onRemoveInviteOnly(RemoveInviteOnlyEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onRemoveModerated(RemoveModeratedEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onRemoveNoExternalMessages(RemoveNoExternalMessagesEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onRemovePrivate(RemovePrivateEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onRemoveSecret(RemoveSecretEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onRemoveTopicProtection(RemoveTopicProtectionEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onServerPing(ServerPingEvent) - Method in class org.pircbotx.hooks.CoreHooks
 
onServerPing(ServerPingEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onServerResponse(ServerResponseEvent) - Method in class org.pircbotx.delay.AdaptingDelay
 
onServerResponse(ServerResponseEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onSetChannelBan(SetChannelBanEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onSetChannelKey(SetChannelKeyEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onSetChannelLimit(SetChannelLimitEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onSetInviteOnly(SetInviteOnlyEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onSetModerated(SetModeratedEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onSetNoExternalMessages(SetNoExternalMessagesEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onSetPrivate(SetPrivateEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onSetSecret(SetSecretEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onSetTopicProtection(SetTopicProtectionEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onSocketConnect(SocketConnectEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onSuperOp(SuperOpEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onTime(TimeEvent) - Method in class org.pircbotx.hooks.CoreHooks
 
onTime(TimeEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onTopic(TopicEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onUnknown(UnknownEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onUserList(UserListEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onUserMode(UserModeEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onVersion(VersionEvent) - Method in class org.pircbotx.hooks.CoreHooks
 
onVersion(VersionEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onVoice(VoiceEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
onWhois(WhoisEvent) - Method in class org.pircbotx.hooks.ListenerAdapter
 
op(UserHostmask) - Method in class org.pircbotx.output.OutputChannel
Grants operator privileges to a user on a channel.
OpEvent - Class in org.pircbotx.hooks.events
Called when a user (possibly us) gets granted operator status for a channel.
OpEvent(PircBotX, Channel, UserHostmask, User, UserHostmask, User, boolean) - Constructor for class org.pircbotx.hooks.events.OpEvent
 
org.pircbotx - package org.pircbotx
Core PircBotX classes
org.pircbotx.cap - package org.pircbotx.cap
 
org.pircbotx.dcc - package org.pircbotx.dcc
 
org.pircbotx.delay - package org.pircbotx.delay
 
org.pircbotx.exception - package org.pircbotx.exception
Custom PircBotX exceptions
org.pircbotx.hooks - package org.pircbotx.hooks
General Listener classes
org.pircbotx.hooks.events - package org.pircbotx.hooks.events
All supported events of PircBotX
org.pircbotx.hooks.managers - package org.pircbotx.hooks.managers
Listener Manager interface and implementations
org.pircbotx.hooks.types - package org.pircbotx.hooks.types
Generic Interfaces for groups of events that do generally the same thing
org.pircbotx.output - package org.pircbotx.output
 
org.pircbotx.snapshot - package org.pircbotx.snapshot
 
OUTPUT_CHAT_MARKER - Static variable in class org.pircbotx.dcc.Chat
 
OUTPUT_MARKER - Static variable in class org.pircbotx.output.OutputRaw
 
OutputCAP - Class in org.pircbotx.output
IRCv3 CAP Negoation commands.
OutputCAP(PircBotX) - Constructor for class org.pircbotx.output.OutputCAP
 
OutputChannel - Class in org.pircbotx.output
Send lines to a channel.
OutputChannel(PircBotX, Channel) - Constructor for class org.pircbotx.output.OutputChannel
 
OutputDCC - Class in org.pircbotx.output
Implementation of the DCC protocol.
OutputDCC(PircBotX) - Constructor for class org.pircbotx.output.OutputDCC
 
OutputEvent - Class in org.pircbotx.hooks.events
A command sent to the IRC server from PircBotX
OutputEvent(PircBotX, String, List<String>) - Constructor for class org.pircbotx.hooks.events.OutputEvent
 
OutputIRC - Class in org.pircbotx.output
Implements the basic IRC protocol.
OutputIRC(PircBotX) - Constructor for class org.pircbotx.output.OutputIRC
 
OutputRaw - Class in org.pircbotx.output
Send raw lines to the server with locking and message delay support.
OutputRaw(PircBotX) - Constructor for class org.pircbotx.output.OutputRaw
 
OutputUser - Class in org.pircbotx.output
Send lines to a serverUser.
OutputUser(PircBotX, UserHostmask) - Constructor for class org.pircbotx.output.OutputUser
 
owner(UserHostmask) - Method in class org.pircbotx.output.OutputChannel
Grants owner privileges to a user on a channel.
OwnerEvent - Class in org.pircbotx.hooks.events
Called when a user (possibly us) gets owner status granted in a channel.
OwnerEvent(PircBotX, Channel, UserHostmask, User, UserHostmask, User, boolean) - Constructor for class org.pircbotx.hooks.events.OwnerEvent
 

P

parse(int, List<String>) - Method in class org.pircbotx.ServerInfo
 
parseCommand(String, GenericMessageEvent) - Static method in class org.pircbotx.Utils
Gets the message from the event and calls Utils.parseCommand(java.lang.String, java.lang.String)
parseCommand(String, String) - Static method in class org.pircbotx.Utils
Parse given command, if it starts with the prefix return the line minus the prefix (the arguments), otherwise return null
parseRawAddress(String) - Static method in class org.pircbotx.dcc.DccHandler
 
part() - Method in class org.pircbotx.output.OutputChannel
Parts a channel.
part(String) - Method in class org.pircbotx.output.OutputChannel
Parts a channel, giving a reason.
PartEvent - Class in org.pircbotx.hooks.events
This event is dispatched whenever someone (possibly us) parts a channel which we are on.
PartEvent(PircBotX, UserChannelDaoSnapshot, ChannelSnapshot, String, UserHostmask, UserSnapshot, String) - Constructor for class org.pircbotx.hooks.events.PartEvent
 
PingEvent - Class in org.pircbotx.hooks.events
This event is dispatched whenever we receive a PING request from another user.
PingEvent(PircBotX, UserHostmask, User, Channel, String) - Constructor for class org.pircbotx.hooks.events.PingEvent
 
PircBotX - Class in org.pircbotx
PircBotX is a Java framework for writing IRC bots quickly and easily.
PircBotX(Configuration) - Constructor for class org.pircbotx.PircBotX
Constructs a PircBotX with the provided configuration.
PircBotX.State - Enum in org.pircbotx
 
PooledListenerExecutor(AbstractListenerManager, Listener, Executor) - Constructor for class org.pircbotx.hooks.managers.SequentialListenerManager.PooledListenerExecutor
 
PrivateMessageEvent - Class in org.pircbotx.hooks.events
This event is dispatched whenever a private message is sent to us.
PrivateMessageEvent(PircBotX, UserHostmask, User, String, ImmutableMap<String, String>) - Constructor for class org.pircbotx.hooks.events.PrivateMessageEvent
 
processCommand(String, UserHostmask, String, String, List<String>, ImmutableMap<String, String>) - Method in class org.pircbotx.InputParser
 
processConnect(String, String, String, List<String>) - Method in class org.pircbotx.InputParser
Process any lines relevant to connect.
processDcc(UserHostmask, User, String) - Method in class org.pircbotx.dcc.DccHandler
 
processMode(UserHostmask, User, String, String) - Method in class org.pircbotx.InputParser
Called when the mode of a channel is set.
processServerResponse(int, String, List<String>) - Method in class org.pircbotx.InputParser
This method is called by the PircBotX when a numeric response is received from the IRC server.
processUserStatus(Channel, User, String) - Method in class org.pircbotx.InputParser
 
ProxySocketFactory - Class in org.pircbotx
A basic SocketFactory for creating sockets that connect through the specified proxy.
ProxySocketFactory(Proxy) - Constructor for class org.pircbotx.ProxySocketFactory
Create all sockets with the specified proxy.
ProxySocketFactory(Proxy.Type, String, int) - Constructor for class org.pircbotx.ProxySocketFactory
A convenience constructor for creating a proxy with the specified host and port.
PURPLE - Static variable in class org.pircbotx.Colors
Purple coloured text.

Q

QuitEvent - Class in org.pircbotx.hooks.events
This event is dispatched whenever someone (possibly us) quits from the server.
QuitEvent(PircBotX, UserChannelDaoSnapshot, UserHostmask, UserSnapshot, String) - Constructor for class org.pircbotx.hooks.events.QuitEvent
 
quitServer() - Method in class org.pircbotx.output.OutputIRC
Quits from the IRC server.
quitServer(String) - Method in class org.pircbotx.output.OutputIRC
Quits from the IRC server with a reason.

R

rawLine(String) - Method in class org.pircbotx.output.OutputRaw
Sends a raw line through the outgoing message queue.
rawLineNow(String) - Method in class org.pircbotx.output.OutputRaw
Sends a raw line to the IRC server as soon as possible without resetting the message delay for messages waiting to send
rawLineNow(String, boolean) - Method in class org.pircbotx.output.OutputRaw
Sends a raw line to the IRC server as soon as possible
rawLineSplit(String, String) - Method in class org.pircbotx.output.OutputRaw
 
rawLineSplit(String, String, String) - Method in class org.pircbotx.output.OutputRaw
 
readLine() - Method in class org.pircbotx.dcc.Chat
Reads the next line of text from the client at the other end of our DCC Chat connection.
realname(String) - Method in class org.pircbotx.hooks.events.WhoisEvent.Builder
 
ReceiveChat - Class in org.pircbotx.dcc
A DCC Chat that was initiated by another user.
ReceiveChat(User, Socket, Charset) - Constructor for class org.pircbotx.dcc.ReceiveChat
 
ReceiveFileTransfer - Class in org.pircbotx.dcc
A DCC File Transfer initiated by another user.
ReceiveFileTransfer(Configuration, Socket, User, File, long, long) - Constructor for class org.pircbotx.dcc.ReceiveFileTransfer
 
RED - Static variable in class org.pircbotx.Colors
Red coloured text.
registeredAs(String) - Method in class org.pircbotx.hooks.events.WhoisEvent.Builder
 
removeChannel(ChannelSnapshot) - Method in class org.pircbotx.snapshot.UserChannelMapSnapshot
 
removeChannel(C) - Method in class org.pircbotx.UserChannelMap
 
RemoveChannelBanEvent - Class in org.pircbotx.hooks.events
Called when a hostmask ban is removed from a channel.
RemoveChannelBanEvent(PircBotX, Channel, UserHostmask, User, UserHostmask) - Constructor for class org.pircbotx.hooks.events.RemoveChannelBanEvent
 
removeChannelKey(String) - Method in class org.pircbotx.output.OutputChannel
Removes the channel key (-k) or password to get into the channel.
RemoveChannelKeyEvent - Class in org.pircbotx.hooks.events
Called when a channel key is removed.
RemoveChannelKeyEvent(PircBotX, Channel, UserHostmask, User, String) - Constructor for class org.pircbotx.hooks.events.RemoveChannelKeyEvent
 
removeChannelLimit() - Method in class org.pircbotx.output.OutputChannel
Attempt to remove the channel limit (-l) on the specified channel.
RemoveChannelLimitEvent - Class in org.pircbotx.hooks.events
Called when the user limit is removed for a channel.
RemoveChannelLimitEvent(PircBotX, Channel, UserHostmask, User) - Constructor for class org.pircbotx.hooks.events.RemoveChannelLimitEvent
 
removeChannelPrivate() - Method in class org.pircbotx.output.OutputChannel
Removes private (-p) status from the channel.
removeColors(String) - Static method in class org.pircbotx.Colors
Removes all colours from a line of IRC text.
removeFormatting(String) - Static method in class org.pircbotx.Colors
Remove formatting from a line of IRC text.
removeFormattingAndColors(String) - Static method in class org.pircbotx.Colors
Removes all formatting and colours from a line of IRC text.
removeInviteOnly() - Method in class org.pircbotx.output.OutputChannel
Removes invite only (-i) status from the channel.
RemoveInviteOnlyEvent - Class in org.pircbotx.hooks.events
Called when a channel has 'invite only' removed.
RemoveInviteOnlyEvent(PircBotX, Channel, UserHostmask, User) - Constructor for class org.pircbotx.hooks.events.RemoveInviteOnlyEvent
 
removeListener(Listener) - Method in class org.pircbotx.hooks.managers.BackgroundListenerManager
 
removeListener(Listener) - Method in class org.pircbotx.hooks.managers.GenericListenerManager
Deprecated.
 
removeListener(Listener) - Method in interface org.pircbotx.hooks.managers.ListenerManager
Remove a listener from this ListenerManager
removeListener(Listener) - Method in class org.pircbotx.hooks.managers.SequentialListenerManager
 
removeListener(Listener) - Method in class org.pircbotx.hooks.managers.ThreadedListenerManager
 
removeModerated() - Method in class org.pircbotx.output.OutputChannel
Removes moderated (-m) status from the channel.
RemoveModeratedEvent - Class in org.pircbotx.hooks.events
Called when a channel has moderated mode removed.
RemoveModeratedEvent(PircBotX, Channel, UserHostmask, User) - Constructor for class org.pircbotx.hooks.events.RemoveModeratedEvent
 
removeNoExternalMessages() - Method in class org.pircbotx.output.OutputChannel
Allow external messages to appear in the channel (+n).
RemoveNoExternalMessagesEvent - Class in org.pircbotx.hooks.events
Called when a channel is set to allow messages from any user, even if they are not actually in the channel.
RemoveNoExternalMessagesEvent(PircBotX, Channel, UserHostmask, User) - Constructor for class org.pircbotx.hooks.events.RemoveNoExternalMessagesEvent
 
RemovePrivateEvent - Class in org.pircbotx.hooks.events
Called when a channel is marked as not being in private mode.
RemovePrivateEvent(PircBotX, Channel, UserHostmask, User) - Constructor for class org.pircbotx.hooks.events.RemovePrivateEvent
 
removeSecret() - Method in class org.pircbotx.output.OutputChannel
Removes secret (-s) status from the channel.
RemoveSecretEvent - Class in org.pircbotx.hooks.events
Called when a channel has 'secret' mode removed.
RemoveSecretEvent(PircBotX, Channel, UserHostmask, User) - Constructor for class org.pircbotx.hooks.events.RemoveSecretEvent
 
removeTopicProtection() - Method in class org.pircbotx.output.OutputChannel
Allow non-operator users to change the channel topic (-t).
RemoveTopicProtectionEvent - Class in org.pircbotx.hooks.events
Called when topic protection is removed for a channel.
RemoveTopicProtectionEvent(PircBotX, Channel, UserHostmask, User) - Constructor for class org.pircbotx.hooks.events.RemoveTopicProtectionEvent
 
removeUser(UserSnapshot) - Method in class org.pircbotx.snapshot.UserChannelMapSnapshot
 
removeUser(U) - Method in class org.pircbotx.UserChannelMap
 
removeUserFromChannel(UserSnapshot, ChannelSnapshot) - Method in class org.pircbotx.snapshot.UserChannelMapSnapshot
 
removeUserFromChannel(U, C) - Method in class org.pircbotx.UserChannelMap
 
replaceCoreHooksListener(CoreHooks) - Method in class org.pircbotx.Configuration.Builder
 
replay(Configuration.Builder, InputStream, String) - Static method in class org.pircbotx.ReplayServer
 
replayFile(File) - Static method in class org.pircbotx.ReplayServer
 
replayFile(File, Configuration.Builder) - Static method in class org.pircbotx.ReplayServer
 
ReplayServer - Class in org.pircbotx
Helpful server for replaying a raw log to the bot.
ReplayServer() - Constructor for class org.pircbotx.ReplayServer
 
ReplyConstants - Class in org.pircbotx
This interface contains the values of all numeric replies specified in section 6 of RFC 1459.
request(String...) - Method in class org.pircbotx.output.OutputCAP
 
reset() - Method in class org.pircbotx.delay.AdaptingDelay
 
reset() - Method in class org.pircbotx.delay.BinaryBackoffDelay
 
respond(String) - Method in class org.pircbotx.hooks.Event
A simple abstract method that all events must implement to respond to an event happening.
respond(String) - Method in class org.pircbotx.hooks.events.ActionEvent
Respond to an action with an action in either the channel that the message came from or a private message.
respond(String) - Method in class org.pircbotx.hooks.events.BanListEvent
Send a message to the channel
respond(String) - Method in class org.pircbotx.hooks.events.ChannelInfoEvent
Respond by sending a raw line to the server.
respond(String) - Method in class org.pircbotx.hooks.events.ConnectAttemptFailedEvent
Deprecated.
respond(String) - Method in class org.pircbotx.hooks.events.ConnectEvent
Responds by sending a raw line to the server.
respond(String) - Method in class org.pircbotx.hooks.events.DisconnectEvent
Deprecated.
respond(String) - Method in class org.pircbotx.hooks.events.ExceptionEvent
 
respond(String) - Method in class org.pircbotx.hooks.events.FingerEvent
Respond with a CTCP response to the user
respond(String) - Method in class org.pircbotx.hooks.events.HalfOpEvent
Respond by send a message in the channel to the user that set the mode (Warning: not to the user that got halfop status!) in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.IncomingChatRequestEvent
Respond with a private message to the user that sent the request, not a message over dcc since it might not of been accepted yet
respond(String) - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
Respond with a private message to the user that sent the request
respond(String) - Method in class org.pircbotx.hooks.events.InviteEvent
Respond with a private message to the user who sent the invite
respond(String) - Method in class org.pircbotx.hooks.events.JoinEvent
Respond with a channel message in user: message format to the user that joined
respond(String) - Method in class org.pircbotx.hooks.events.KickEvent
Respond with a channel message in user: message format to the user that preformed the kick
respond(String) - Method in class org.pircbotx.hooks.events.MessageEvent
Respond with a channel message in user: message format to the user that sent the message
respond(String) - Method in class org.pircbotx.hooks.events.ModeEvent
Respond by send a message in the channel to the user that set the mode in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.MotdEvent
Responds by sending a raw line to the server.
respond(String) - Method in class org.pircbotx.hooks.events.NickAlreadyInUseEvent
Respond by sending a NICK change
respond(String) - Method in class org.pircbotx.hooks.events.NickChangeEvent
Respond by sending a private message to the user's new nick
respond(String) - Method in class org.pircbotx.hooks.events.NoticeEvent
Respond by sending a message to the channel in user: message, or if its a private message respond with a private message to the user format.
respond(String) - Method in class org.pircbotx.hooks.events.OpEvent
Respond by send a message in the channel to the user that set the mode (Warning: not to the user that got operator status!) in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.OutputEvent
Deprecated.
Cannot respond to output
respond(String) - Method in class org.pircbotx.hooks.events.OwnerEvent
Respond by send a message in the channel to the user that set the mode (Warning: not to the user that got owner status!) in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.PartEvent
Respond by sending a message to the channel
respond(String) - Method in class org.pircbotx.hooks.events.PingEvent
Respond with a CTCP response to the user
respond(String) - Method in class org.pircbotx.hooks.events.PrivateMessageEvent
Respond with a private message to the user that sent the message
respond(String) - Method in class org.pircbotx.hooks.events.QuitEvent
Deprecated.
respond(String) - Method in class org.pircbotx.hooks.events.RemoveChannelBanEvent
Respond by send a message in the channel to the user that set the mode (Warning: not to the user that got unbanned!) in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.RemoveChannelKeyEvent
Respond by send a message in the channel to the user that removed the mode in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.RemoveChannelLimitEvent
Respond by send a message in the channel to the user that removed the mode in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.RemoveInviteOnlyEvent
Respond by send a message in the channel to the user that removed the mode in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.RemoveModeratedEvent
Respond by send a message in the channel to the user that removed the mode in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.RemoveNoExternalMessagesEvent
Respond by send a message in the channel to the user that removed the mode in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.RemovePrivateEvent
Respond by send a message in the channel to the user that removed the mode in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.RemoveSecretEvent
Respond by send a message in the channel to the user that removed the mode in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.RemoveTopicProtectionEvent
Respond by send a message in the channel to the user that removed the mode in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.ServerPingEvent
Respond with a raw line to the server
respond(String) - Method in class org.pircbotx.hooks.events.ServerResponseEvent
Respond with a raw line to the server
respond(String) - Method in class org.pircbotx.hooks.events.SetChannelBanEvent
Respond by send a message in the channel to the user that set the mode (Warning: not to the user that got banned!) in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.SetChannelKeyEvent
Respond by send a message in the channel to the user that set the mode in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.SetChannelLimitEvent
Respond by send a message in the channel to the user that set the mode in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.SetInviteOnlyEvent
Respond by send a message in the channel to the user that set the mode in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.SetModeratedEvent
Respond by send a message in the channel to the user that set the mode in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.SetNoExternalMessagesEvent
Respond by send a message in the channel to the user that set the mode in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.SetPrivateEvent
Respond by send a message in the channel to the user that set the mode in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.SetSecretEvent
Respond by send a message in the channel to the user that set the mode in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.SetTopicProtectionEvent
Respond by send a message in the channel to the user that set the mode in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.SocketConnectEvent
Responds by sending a raw line to the server.
respond(String) - Method in class org.pircbotx.hooks.events.SuperOpEvent
Respond by send a message in the channel to the user that set the mode (Warning: not to the user that got SuperOp status!) in user: message format
respond(String) - Method in class org.pircbotx.hooks.events.TimeEvent
Respond with a CTCP response to the user
respond(String) - Method in class org.pircbotx.hooks.events.TopicEvent
Respond with a channel message in user: message format to the user that set the message
respond(String) - Method in class org.pircbotx.hooks.events.UnknownEvent
Responds by sending a raw line to the server.
respond(String) - Method in class org.pircbotx.hooks.events.UserListEvent
Respond with a message to the channel that the userlist was from
respond(String) - Method in class org.pircbotx.hooks.events.UserModeEvent
Respond with a private message to the source user
respond(String) - Method in class org.pircbotx.hooks.events.VersionEvent
Respond with a CTCP response to the user
respond(String) - Method in class org.pircbotx.hooks.events.VoiceEvent
 
respond(String) - Method in class org.pircbotx.hooks.events.WhoisEvent
 
respond(String) - Method in interface org.pircbotx.hooks.types.GenericEvent
Send a response using the underlying event's respond() method
respondChannel(String) - Method in class org.pircbotx.hooks.events.ActionEvent
Respond with a message to the channel without the prefix
respondChannel(String) - Method in class org.pircbotx.hooks.events.MessageEvent
Respond with a message to the channel without the prefix
respondChannel(String) - Method in class org.pircbotx.hooks.events.NoticeEvent
Respond with a message to the channel without the prefix
respondPrivateMessage(String) - Method in class org.pircbotx.hooks.events.ActionEvent
Respond with a PM directly to the user
respondPrivateMessage(String) - Method in class org.pircbotx.hooks.events.MessageEvent
Respond with a PM directly to the user
respondPrivateMessage(String) - Method in class org.pircbotx.hooks.events.NoticeEvent
Respond with a PM directly to the user
respondPrivateMessage(String) - Method in class org.pircbotx.hooks.events.PrivateMessageEvent
 
respondPrivateMessage(String) - Method in interface org.pircbotx.hooks.types.GenericMessageEvent
Send message directly to the user
respondWith(String) - Method in class org.pircbotx.hooks.events.ActionEvent
 
respondWith(String) - Method in class org.pircbotx.hooks.events.MessageEvent
 
respondWith(String) - Method in class org.pircbotx.hooks.events.NoticeEvent
 
respondWith(String) - Method in class org.pircbotx.hooks.events.PrivateMessageEvent
 
respondWith(String) - Method in interface org.pircbotx.hooks.types.GenericMessageEvent
Like GenericEvent.respond(String), without the Username: prefix
REVERSE - Static variable in class org.pircbotx.Colors
Reversed text (may be rendered as italic text in some clients).
RPL_ADMINEMAIL - Static variable in class org.pircbotx.ReplyConstants
 
RPL_ADMINLOC1 - Static variable in class org.pircbotx.ReplyConstants
 
RPL_ADMINLOC2 - Static variable in class org.pircbotx.ReplyConstants
 
RPL_ADMINME - Static variable in class org.pircbotx.ReplyConstants
 
RPL_AWAY - Static variable in class org.pircbotx.ReplyConstants
 
RPL_BANLIST - Static variable in class org.pircbotx.ReplyConstants
 
RPL_CHANNELMODEIS - Static variable in class org.pircbotx.ReplyConstants
 
RPL_CLOSEEND - Static variable in class org.pircbotx.ReplyConstants
 
RPL_CLOSING - Static variable in class org.pircbotx.ReplyConstants
 
RPL_ENDOFBANLIST - Static variable in class org.pircbotx.ReplyConstants
 
RPL_ENDOFINFO - Static variable in class org.pircbotx.ReplyConstants
 
RPL_ENDOFLINKS - Static variable in class org.pircbotx.ReplyConstants
 
RPL_ENDOFMOTD - Static variable in class org.pircbotx.ReplyConstants
 
RPL_ENDOFNAMES - Static variable in class org.pircbotx.ReplyConstants
 
RPL_ENDOFSERVICES - Static variable in class org.pircbotx.ReplyConstants
 
RPL_ENDOFSTATS - Static variable in class org.pircbotx.ReplyConstants
 
RPL_ENDOFUSERS - Static variable in class org.pircbotx.ReplyConstants
 
RPL_ENDOFWHO - Static variable in class org.pircbotx.ReplyConstants
 
RPL_ENDOFWHOIS - Static variable in class org.pircbotx.ReplyConstants
 
RPL_ENDOFWHOWAS - Static variable in class org.pircbotx.ReplyConstants
 
RPL_INFO - Static variable in class org.pircbotx.ReplyConstants
 
RPL_INFOSTART - Static variable in class org.pircbotx.ReplyConstants
 
RPL_INVITING - Static variable in class org.pircbotx.ReplyConstants
 
RPL_ISON - Static variable in class org.pircbotx.ReplyConstants
 
RPL_KILLDONE - Static variable in class org.pircbotx.ReplyConstants
 
RPL_LINKS - Static variable in class org.pircbotx.ReplyConstants
 
RPL_LIST - Static variable in class org.pircbotx.ReplyConstants
 
RPL_LISTEND - Static variable in class org.pircbotx.ReplyConstants
 
RPL_LISTSTART - Static variable in class org.pircbotx.ReplyConstants
 
RPL_LUSERCHANNELS - Static variable in class org.pircbotx.ReplyConstants
 
RPL_LUSERCLIENT - Static variable in class org.pircbotx.ReplyConstants
 
RPL_LUSERME - Static variable in class org.pircbotx.ReplyConstants
 
RPL_LUSEROP - Static variable in class org.pircbotx.ReplyConstants
 
RPL_LUSERUNKNOWN - Static variable in class org.pircbotx.ReplyConstants
 
RPL_MOTD - Static variable in class org.pircbotx.ReplyConstants
 
RPL_MOTDSTART - Static variable in class org.pircbotx.ReplyConstants
 
RPL_MYPORTIS - Static variable in class org.pircbotx.ReplyConstants
 
RPL_NAMREPLY - Static variable in class org.pircbotx.ReplyConstants
 
RPL_NONE - Static variable in class org.pircbotx.ReplyConstants
 
RPL_NOTOPIC - Static variable in class org.pircbotx.ReplyConstants
 
RPL_NOUSERS - Static variable in class org.pircbotx.ReplyConstants
 
RPL_NOWAWAY - Static variable in class org.pircbotx.ReplyConstants
 
RPL_REHASHING - Static variable in class org.pircbotx.ReplyConstants
 
RPL_SERVICE - Static variable in class org.pircbotx.ReplyConstants
 
RPL_SERVICEINFO - Static variable in class org.pircbotx.ReplyConstants
 
RPL_SERVLIST - Static variable in class org.pircbotx.ReplyConstants
 
RPL_SERVLISTEND - Static variable in class org.pircbotx.ReplyConstants
 
RPL_STATSCLINE - Static variable in class org.pircbotx.ReplyConstants
 
RPL_STATSCOMMANDS - Static variable in class org.pircbotx.ReplyConstants
 
RPL_STATSHLINE - Static variable in class org.pircbotx.ReplyConstants
 
RPL_STATSILINE - Static variable in class org.pircbotx.ReplyConstants
 
RPL_STATSKLINE - Static variable in class org.pircbotx.ReplyConstants
 
RPL_STATSLINKINFO - Static variable in class org.pircbotx.ReplyConstants
 
RPL_STATSLLINE - Static variable in class org.pircbotx.ReplyConstants
 
RPL_STATSNLINE - Static variable in class org.pircbotx.ReplyConstants
 
RPL_STATSOLINE - Static variable in class org.pircbotx.ReplyConstants
 
RPL_STATSQLINE - Static variable in class org.pircbotx.ReplyConstants
 
RPL_STATSUPTIME - Static variable in class org.pircbotx.ReplyConstants
 
RPL_STATSYLINE - Static variable in class org.pircbotx.ReplyConstants
 
RPL_SUMMONING - Static variable in class org.pircbotx.ReplyConstants
 
RPL_TIME - Static variable in class org.pircbotx.ReplyConstants
 
RPL_TOPIC - Static variable in class org.pircbotx.ReplyConstants
 
RPL_TOPICINFO - Static variable in class org.pircbotx.ReplyConstants
 
RPL_TRACECLASS - Static variable in class org.pircbotx.ReplyConstants
 
RPL_TRACECONNECTING - Static variable in class org.pircbotx.ReplyConstants
 
RPL_TRACEHANDSHAKE - Static variable in class org.pircbotx.ReplyConstants
 
RPL_TRACELINK - Static variable in class org.pircbotx.ReplyConstants
 
RPL_TRACELOG - Static variable in class org.pircbotx.ReplyConstants
 
RPL_TRACENEWTYPE - Static variable in class org.pircbotx.ReplyConstants
 
RPL_TRACEOPERATOR - Static variable in class org.pircbotx.ReplyConstants
 
RPL_TRACESERVER - Static variable in class org.pircbotx.ReplyConstants
 
RPL_TRACEUNKNOWN - Static variable in class org.pircbotx.ReplyConstants
 
RPL_TRACEUSER - Static variable in class org.pircbotx.ReplyConstants
 
RPL_UMODEIS - Static variable in class org.pircbotx.ReplyConstants
 
RPL_UNAWAY - Static variable in class org.pircbotx.ReplyConstants
 
RPL_USERHOST - Static variable in class org.pircbotx.ReplyConstants
 
RPL_USERS - Static variable in class org.pircbotx.ReplyConstants
 
RPL_USERSSTART - Static variable in class org.pircbotx.ReplyConstants
 
RPL_VERSION - Static variable in class org.pircbotx.ReplyConstants
 
RPL_WHOIS_SECURE - Static variable in class org.pircbotx.ReplyConstants
 
RPL_WHOISCHANNELS - Static variable in class org.pircbotx.ReplyConstants
 
RPL_WHOISCHANOP - Static variable in class org.pircbotx.ReplyConstants
 
RPL_WHOISIDLE - Static variable in class org.pircbotx.ReplyConstants
 
RPL_WHOISOPERATOR - Static variable in class org.pircbotx.ReplyConstants
 
RPL_WHOISSERVER - Static variable in class org.pircbotx.ReplyConstants
 
RPL_WHOISUSER - Static variable in class org.pircbotx.ReplyConstants
 
RPL_WHOREPLY - Static variable in class org.pircbotx.ReplyConstants
 
RPL_WHOWASUSER - Static variable in class org.pircbotx.ReplyConstants
 
RPL_YOUREOPER - Static variable in class org.pircbotx.ReplyConstants
 
run() - Method in class org.pircbotx.IdentServer
Waits for a client to connect to the ident server before making an appropriate response.

S

SASLCapHandler - Class in org.pircbotx.cap
 
SASLCapHandler(String, String) - Constructor for class org.pircbotx.cap.SASLCapHandler
Create SASLCapHandler not ignoring failed authentication and throwing a CapException
SASLCapHandler(String, String, boolean) - Constructor for class org.pircbotx.cap.SASLCapHandler
 
secureConnection(boolean) - Method in class org.pircbotx.hooks.events.WhoisEvent.Builder
 
send() - Method in class org.pircbotx.Channel
Send a line to the channel.
send() - Method in class org.pircbotx.PircBotX
Deprecated.
send() - Method in class org.pircbotx.UserHostmask
Send a line to the user.
sendCAP() - Method in class org.pircbotx.PircBotX
 
sendChat(User) - Method in class org.pircbotx.dcc.DccHandler
Send a chat request using Configuration.isDccPassiveRequest()
sendChat(User, boolean) - Method in class org.pircbotx.dcc.DccHandler
Send a chat request using passive parameter
SendChat - Class in org.pircbotx.dcc
A DCC Chat initiated by the bot.
SendChat(User, Socket, Charset) - Constructor for class org.pircbotx.dcc.SendChat
 
sendDCC() - Method in class org.pircbotx.PircBotX
 
sendFile(File, User) - Method in class org.pircbotx.dcc.DccHandler
sendFile(File, User, boolean) - Method in class org.pircbotx.dcc.DccHandler
SendFileTransfer - Class in org.pircbotx.dcc
A DCC File Transfer initiated by the bot
SendFileTransfer(Configuration, Socket, User, File, long) - Constructor for class org.pircbotx.dcc.SendFileTransfer
 
sendIRC() - Method in class org.pircbotx.PircBotX
 
sendLine(String) - Method in class org.pircbotx.dcc.Chat
Sends a line of text to the client at the other end of our DCC Chat connection.
sendRaw() - Method in class org.pircbotx.PircBotX
 
sendRawLineToServer(PircBotX, String) - Static method in class org.pircbotx.Utils
Sends a raw line to the server.
SequentialListenerExecutor(SequentialListenerManager, Listener) - Constructor for class org.pircbotx.hooks.managers.SequentialListenerManager.SequentialListenerExecutor
 
SequentialListenerManager - Class in org.pircbotx.hooks.managers
PircBotX receives and processes all input from the server in the "bot/network loop".
SequentialListenerManager.InlineListenerExecutor - Class in org.pircbotx.hooks.managers
 
SequentialListenerManager.ListenerExecutor - Interface in org.pircbotx.hooks.managers
 
SequentialListenerManager.PooledListenerExecutor - Class in org.pircbotx.hooks.managers
 
SequentialListenerManager.SequentialListenerExecutor - Class in org.pircbotx.hooks.managers
 
SequentialListenerManager.SequentialListenerManagerBuilder - Class in org.pircbotx.hooks.managers
 
SequentialListenerManagerBuilder() - Constructor for class org.pircbotx.hooks.managers.SequentialListenerManager.SequentialListenerManagerBuilder
 
sequentialThreadFactory(ThreadFactory) - Method in class org.pircbotx.hooks.managers.SequentialListenerManager.SequentialListenerManagerBuilder
 
server(String) - Method in class org.pircbotx.hooks.events.WhoisEvent.Builder
 
ServerEntry(String, int) - Constructor for class org.pircbotx.Configuration.ServerEntry
 
serverInfo(String) - Method in class org.pircbotx.hooks.events.WhoisEvent.Builder
 
ServerInfo - Class in org.pircbotx
This is a giant info bean of various things about the server.
ServerInfo(PircBotX) - Constructor for class org.pircbotx.ServerInfo
 
ServerPingEvent - Class in org.pircbotx.hooks.events
The actions to perform when a PING request comes from the server.
ServerPingEvent(PircBotX, String) - Constructor for class org.pircbotx.hooks.events.ServerPingEvent
 
ServerResponseEvent - Class in org.pircbotx.hooks.events
This is called when we receive a numeric response from the IRC server.
ServerResponseEvent(PircBotX, int, String, ImmutableList<String>) - Constructor for class org.pircbotx.hooks.events.ServerResponseEvent
 
set(String, String) - Static method in class org.pircbotx.Colors
Sets the text color for a given message and appends Colors.NORMAL
set(String, String, String) - Static method in class org.pircbotx.Colors
Sets the text and background color for a given message and appends Colors.NORMAL
setAutoNickChange(boolean) - Method in class org.pircbotx.Configuration.Builder
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
setAutoReconnect(boolean) - Method in class org.pircbotx.Configuration.Builder
Enable or disable automatic reconnecting, default false.
setAutoReconnectAttempts(int) - Method in class org.pircbotx.Configuration.Builder
Number of times to attempt to reconnect, default 5.
setAutoReconnectDelay(Delay) - Method in class org.pircbotx.Configuration.Builder
Delay in milliseconds between reconnect attempts, default 0.
setAutoSplitMessage(boolean) - Method in class org.pircbotx.Configuration.Builder
Enable or disable automatic message splitting to fit Configuration.Builder.getMaxLineLength() to prevent the IRC server from possibly truncating or rejecting the line, default true.
setBotFactory(Configuration.BotFactory) - Method in class org.pircbotx.Configuration.Builder
setCapEnabled(boolean) - Method in class org.pircbotx.Configuration.Builder
Enable or disable CAP handling, defaults true.
SetChannelBanEvent - Class in org.pircbotx.hooks.events
Called when a user (possibly us) gets banned from a channel.
SetChannelBanEvent(PircBotX, Channel, UserHostmask, User, UserHostmask) - Constructor for class org.pircbotx.hooks.events.SetChannelBanEvent
 
setChannelKey(String) - Method in class org.pircbotx.output.OutputChannel
Sets the channel key (+k) or password to get into the channel.
SetChannelKeyEvent - Class in org.pircbotx.hooks.events
Called when a channel key is set.
SetChannelKeyEvent(PircBotX, Channel, UserHostmask, User, String) - Constructor for class org.pircbotx.hooks.events.SetChannelKeyEvent
 
setChannelLimit(int) - Method in class org.pircbotx.output.OutputChannel
Attempt to set the channel limit (+l) to specified value.
SetChannelLimitEvent - Class in org.pircbotx.hooks.events
Called when a user limit is set for a channel.
SetChannelLimitEvent(PircBotX, Channel, UserHostmask, User, int) - Constructor for class org.pircbotx.hooks.events.SetChannelLimitEvent
 
setChannelPrefixes(String) - Method in class org.pircbotx.Configuration.Builder
Allowed channel prefix characters, default #&+!
setChannelPrivate() - Method in class org.pircbotx.output.OutputChannel
Set the channel as private (+p).
setDao(UserChannelDaoSnapshot) - Method in class org.pircbotx.snapshot.ChannelSnapshot
 
setDao(UserChannelDaoSnapshot) - Method in class org.pircbotx.snapshot.UserSnapshot
 
setDccAcceptTimeout(int) - Method in class org.pircbotx.Configuration.Builder
Timeout for user to accept a sent DCC request, defaults to Configuration.Builder.getSocketTimeout()
setDccFilenameQuotes(boolean) - Method in class org.pircbotx.Configuration.Builder
If true sends filenames in quotes, otherwise uses underscores, default enabled.
setDccLocalAddress(InetAddress) - Method in class org.pircbotx.Configuration.Builder
The local address to bind DCC connections to, defaults to null (which will be figured out at runtime)
setDccPassiveRequest(boolean) - Method in class org.pircbotx.Configuration.Builder
Send DCC requests as passive/reverse requests if not specified otherwise, default false
setDccPorts(List<Integer>) - Method in class org.pircbotx.Configuration.Builder
Ports to allow DCC incoming connections, recommended to set multiple as DCC connections will be rejected if no free port can be found
setDccPublicAddress(InetAddress) - Method in class org.pircbotx.Configuration.Builder
The public address advertised to other users, defaults to null (which will be figured out at runtime)
setDccResumeAcceptTimeout(int) - Method in class org.pircbotx.Configuration.Builder
Timeout for a user to accept a resumed DCC request, defaults to Configuration.Builder.getDccResumeAcceptTimeout()
setDccTransferBufferSize(int) - Method in class org.pircbotx.Configuration.Builder
Size of the DCC file transfer buffer, default 1024 bytes
setDelay(long) - Method in class org.pircbotx.delay.StaticDelay
 
setEncoding(Charset) - Method in class org.pircbotx.Configuration.Builder
Charset encoding to use for connection, defaults to Charset.defaultCharset()
setFinger(String) - Method in class org.pircbotx.Configuration.Builder
CTCP finger response
setIdentServerEnabled(boolean) - Method in class org.pircbotx.Configuration.Builder
Enable or disable use of an existing IdentServer, default false.
setInitialDelay(long) - Method in class org.pircbotx.delay.AdaptingDelay
 
setInitialDelay(long) - Method in class org.pircbotx.delay.BinaryBackoffDelay
 
setInviteOnly() - Method in class org.pircbotx.output.OutputChannel
Set the channel as invite only (+i).
SetInviteOnlyEvent - Class in org.pircbotx.hooks.events
Called when a channel is set to 'invite only' mode.
SetInviteOnlyEvent(PircBotX, Channel, UserHostmask, User) - Constructor for class org.pircbotx.hooks.events.SetInviteOnlyEvent
 
setListenerManager(ListenerManager) - Method in class org.pircbotx.Configuration.Builder
Sets a new ListenerManager.
setLocalAddress(InetAddress) - Method in class org.pircbotx.Configuration.Builder
Address to bind to when connecting to IRC server, default null
setLocale(Locale) - Method in class org.pircbotx.Configuration.Builder
Locale to use for connection, defaults to Locale.getDefault()
setLogin(String) - Method in class org.pircbotx.Configuration.Builder
The login to be used for the IRC connection (nick!login@host), default PircBotX
setMaxDelay(long) - Method in class org.pircbotx.delay.AdaptingDelay
 
setMaxDelay(long) - Method in class org.pircbotx.delay.BinaryBackoffDelay
 
setMaxLineLength(int) - Method in class org.pircbotx.Configuration.Builder
Maximum line length of IRC server, defaults 512 characters
setMessageDelay(Delay) - Method in class org.pircbotx.Configuration.Builder
Millisecond delay between sending messages, default 1000 milliseconds
setMode(String) - Method in class org.pircbotx.output.OutputChannel
Set the mode of a channel.
setMode(String, Object...) - Method in class org.pircbotx.output.OutputChannel
Set a mode for the channel with arguments.
setMode(String, UserHostmask) - Method in class org.pircbotx.output.OutputChannel
Set a mode for a user.
setModerated() - Method in class org.pircbotx.output.OutputChannel
Set the channel as moderated (+m).
SetModeratedEvent - Class in org.pircbotx.hooks.events
Called when a channel is set to 'moderated' mode.
SetModeratedEvent(PircBotX, Channel, UserHostmask, User) - Constructor for class org.pircbotx.hooks.events.SetModeratedEvent
 
setName(String) - Method in class org.pircbotx.Configuration.Builder
The nick to be used for the IRC connection (nick!login@host), must not be blank
setNickservCustomMessage(String) - Method in class org.pircbotx.Configuration.Builder
Some irc servers require a custom identify string.
setNickservDelayJoin(boolean) - Method in class org.pircbotx.Configuration.Builder
Delay joining channels until were identified to nickserv, default false
setNickServIdentified(PircBotX) - Static method in class org.pircbotx.Utils
Sets bot as identified to nickserv.
setNickservNick(String) - Method in class org.pircbotx.Configuration.Builder
The nick of the nickserv service account, default "nickserv".
setNickservOnSuccess(String) - Method in class org.pircbotx.Configuration.Builder
Case-insensitive message a user with Configuration.Builder.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
setNickservPassword(String) - Method in class org.pircbotx.Configuration.Builder
Password to authenticate against NICKSERV, default null (will not try to identify)
setNoExternalMessages() - Method in class org.pircbotx.output.OutputChannel
Prevent external messages from appearing in the channel (+n).
SetNoExternalMessagesEvent - Class in org.pircbotx.hooks.events
Called when a channel is set to only allow messages from users that are in the channel.
SetNoExternalMessagesEvent(PircBotX, Channel, UserHostmask, User) - Constructor for class org.pircbotx.hooks.events.SetNoExternalMessagesEvent
 
setOnJoinWhoEnabled(boolean) - Method in class org.pircbotx.Configuration.Builder
Enable or disable sending "WHO #channel" upon joining a channel and rely only on the NAMES response
SetPrivateEvent - Class in org.pircbotx.hooks.events
Called when a channel is marked as being in private mode.
SetPrivateEvent(PircBotX, Channel, UserHostmask, User) - Constructor for class org.pircbotx.hooks.events.SetPrivateEvent
 
setRealName(String) - Method in class org.pircbotx.Configuration.Builder
The realName/fullname used for WHOIS info, defaults to version
setSecret() - Method in class org.pircbotx.output.OutputChannel
Set the channel as secret (+s).
SetSecretEvent - Class in org.pircbotx.hooks.events
Called when a channel is set to be in 'secret' mode.
SetSecretEvent(PircBotX, Channel, UserHostmask, User) - Constructor for class org.pircbotx.hooks.events.SetSecretEvent
 
setServer(String) - Method in class org.pircbotx.Configuration.Builder
Deprecated.
Use Configuration.Builder.addServer(java.lang.String), will be removed in future releases
setServer(String, int) - Method in class org.pircbotx.Configuration.Builder
Deprecated.
Use Configuration.Builder.addServer(java.lang.String, int), will be removed in future releases
setServerHostname(String) - Method in class org.pircbotx.Configuration.Builder
Deprecated.
Use Configuration.Builder.addServer(java.lang.String), will be removed in future releases
setServerPassword(String) - Method in class org.pircbotx.Configuration.Builder
Password for IRC server, default null
setServerPort(int) - Method in class org.pircbotx.Configuration.Builder
Deprecated.
Use Configuration.Builder.addServer(java.lang.String, int), will be removed in future releases
setServers(List<Configuration.ServerEntry>) - Method in class org.pircbotx.Configuration.Builder
List of servers to connect to, easily add with the addServer methods
setShutdownHookEnabled(boolean) - Method in class org.pircbotx.Configuration.Builder
Enable or disable creating a JVM shutdown hook which will properly QUIT the IRC server and shutdown the bot, default true
setSnapshotsEnabled(boolean) - Method in class org.pircbotx.Configuration.Builder
Enable creation of snapshots, default true.
setSocketConnectTimeout(int) - Method in class org.pircbotx.Configuration.Builder
Milliseconds to wait to connect to an IRC server address before trying the next address, default Configuration.Builder.getSocketTimeout()
setSocketFactory(SocketFactory) - Method in class org.pircbotx.Configuration.Builder
Socket factory for connections, defaults to SocketFactory.getDefault()
setSocketTimeout(int) - Method in class org.pircbotx.Configuration.Builder
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)
setTopic(String) - Method in class org.pircbotx.output.OutputChannel
Set the topic for a channel.
setTopicProtection() - Method in class org.pircbotx.output.OutputChannel
Prevent non-operator users from changing the channel topic (+t).
SetTopicProtectionEvent - Class in org.pircbotx.hooks.events
Called when topic protection is enabled for a channel.
SetTopicProtectionEvent(PircBotX, Channel, UserHostmask, User) - Constructor for class org.pircbotx.hooks.events.SetTopicProtectionEvent
 
setUserLevelPrefixes(String) - Method in class org.pircbotx.Configuration.Builder
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 +@%&~!
setUserModeHideRealHost(boolean) - Method in class org.pircbotx.Configuration.Builder
Sets mode +x on the bot, to hide the real hostname, default = false
setVersion(String) - Method in class org.pircbotx.Configuration.Builder
CTCP version response.
setWebIrcAddress(InetAddress) - Method in class org.pircbotx.Configuration.Builder
IP address of WEBIRC connection, must be set if WEBIRC is enabled
setWebIrcEnabled(boolean) - Method in class org.pircbotx.Configuration.Builder
Enable or disable sending WEBIRC line on connect, default disabled
setWebIrcHostname(String) - Method in class org.pircbotx.Configuration.Builder
Hostname of WEBIRC connection, must not be blank if WEBIRC is enabled
setWebIrcPassword(String) - Method in class org.pircbotx.Configuration.Builder
Password of WEBIRC connection, must not be blank if WEBIRC is enabled
setWebIrcUsername(String) - Method in class org.pircbotx.Configuration.Builder
Username of WEBIRC connection, must not be blank if WEBIRC is enabled
shutdown(PircBotX) - Method in class org.pircbotx.hooks.managers.GenericListenerManager
Deprecated.
 
shutdown(PircBotX) - Method in interface org.pircbotx.hooks.managers.ListenerManager
 
shutdown(PircBotX) - Method in class org.pircbotx.hooks.managers.SequentialListenerManager
 
shutdown() - Method in class org.pircbotx.hooks.managers.ThreadedListenerManager
Shuts down the internal thread pool.
shutdown(PircBotX) - Method in class org.pircbotx.hooks.managers.ThreadedListenerManager
 
signOnTime(long) - Method in class org.pircbotx.hooks.events.WhoisEvent.Builder
 
SnapshotUtils - Class in org.pircbotx.snapshot
 
SocketConnectEvent - Class in org.pircbotx.hooks.events
This event is dispatched once we successfully connected to the IRC server.
SocketConnectEvent(PircBotX) - Constructor for class org.pircbotx.hooks.events.SocketConnectEvent
Default constructor to setup object.
start() - Method in class org.pircbotx.IdentServer
Start the ident server in a new thread.
start() - Method in class org.pircbotx.MultiBotManager
Start the manager, connecting all queued bots.
startBot() - Method in class org.pircbotx.PircBotX
Start the bot by connecting to the server.
startServer() - Static method in class org.pircbotx.IdentServer
Start the ident server with the systems default charset.
startServer(Charset, InetAddress) - Static method in class org.pircbotx.IdentServer
Start the ident server with the specified charset.
StaticDelay - Class in org.pircbotx.delay
 
StaticDelay(long) - Constructor for class org.pircbotx.delay.StaticDelay
 
stop() - Method in class org.pircbotx.MultiBotManager
Stop with no quit message
stop(String) - Method in class org.pircbotx.MultiBotManager
Disconnect all bots from their respective severs cleanly.
stopAndWait() - Method in class org.pircbotx.MultiBotManager
MultiBotManager.stop() and wait for all bots to disconnect.
stopBotReconnect() - Method in class org.pircbotx.PircBotX
Do not try connecting again in the future.
stopServer() - Static method in class org.pircbotx.IdentServer
Stop the server and clear pending ident responses.
superOp(UserHostmask) - Method in class org.pircbotx.output.OutputChannel
Grants superOp privileges to a user on a channel.
SuperOpEvent - Class in org.pircbotx.hooks.events
Called when a user (possibly us) gets superop status granted in a channel.
SuperOpEvent(PircBotX, Channel, UserHostmask, User, UserHostmask, User, boolean) - Constructor for class org.pircbotx.hooks.events.SuperOpEvent
 

T

TEAL - Static variable in class org.pircbotx.Colors
Teal coloured text.
TemporaryListener - Class in org.pircbotx.hooks
Listener for short one-off tasks.
TemporaryListener(PircBotX) - Constructor for class org.pircbotx.hooks.TemporaryListener
Create a TemporaryListener for the specified bot
ThreadedListenerManager - Class in org.pircbotx.hooks.managers
ListenerManager that runs individual listeners in their own thread per event.
ThreadedListenerManager() - Constructor for class org.pircbotx.hooks.managers.ThreadedListenerManager
Configures with default cached thread thread pool.
ThreadedListenerManager(ExecutorService) - Constructor for class org.pircbotx.hooks.managers.ThreadedListenerManager
Configures with specified thread pool
ThreadedListenerManager.ManagedFutureTask - Class in org.pircbotx.hooks.managers
 
TimeEvent - Class in org.pircbotx.hooks.events
This event is dispatched whenever we receive a TIME request.
TimeEvent(PircBotX, Channel, UserHostmask, User) - Constructor for class org.pircbotx.hooks.events.TimeEvent
 
TLSCapHandler - Class in org.pircbotx.cap
CAP STARTTLS support *MUST BE LAST CAP HANDLER*.
TLSCapHandler() - Constructor for class org.pircbotx.cap.TLSCapHandler
 
TLSCapHandler(SSLSocketFactory, boolean) - Constructor for class org.pircbotx.cap.TLSCapHandler
 
tokenizeLine(String) - Static method in class org.pircbotx.Utils
Tokenize IRC raw input into it's components, keeping the 'sender' and 'message' fields intact.
TopicEvent - Class in org.pircbotx.hooks.events
This event is dispatched whenever a user sets the topic, or when we join a new channel and discovers its topic.
TopicEvent(PircBotX, Channel, String, String, UserHostmask, long, boolean) - Constructor for class org.pircbotx.hooks.events.TopicEvent
 
toString() - Method in class org.pircbotx.cap.EnableCapHandler
 
toString() - Method in class org.pircbotx.cap.SASLCapHandler
 
toString() - Method in class org.pircbotx.cap.TLSCapHandler
 
toString() - Method in class org.pircbotx.Channel
 
toString() - Method in class org.pircbotx.ChannelListEntry
 
toString() - Method in class org.pircbotx.ChannelModeHandler
 
toString() - Method in class org.pircbotx.Configuration.Builder
 
toString() - Method in class org.pircbotx.Configuration.ServerEntry
 
toString() - Method in class org.pircbotx.Configuration
 
toString() - Method in class org.pircbotx.hooks.events.ActionEvent
 
toString() - Method in class org.pircbotx.hooks.events.BanListEvent.Entry
 
toString() - Method in class org.pircbotx.hooks.events.BanListEvent
 
toString() - Method in class org.pircbotx.hooks.events.ChannelInfoEvent
 
toString() - Method in class org.pircbotx.hooks.events.ConnectAttemptFailedEvent
 
toString() - Method in class org.pircbotx.hooks.events.ConnectEvent
 
toString() - Method in class org.pircbotx.hooks.events.DisconnectEvent
 
toString() - Method in class org.pircbotx.hooks.events.ExceptionEvent
 
toString() - Method in class org.pircbotx.hooks.events.FingerEvent
 
toString() - Method in class org.pircbotx.hooks.events.HalfOpEvent
 
toString() - Method in class org.pircbotx.hooks.events.IncomingChatRequestEvent
 
toString() - Method in class org.pircbotx.hooks.events.IncomingFileTransferEvent
 
toString() - Method in class org.pircbotx.hooks.events.InviteEvent
 
toString() - Method in class org.pircbotx.hooks.events.JoinEvent
 
toString() - Method in class org.pircbotx.hooks.events.KickEvent
 
toString() - Method in class org.pircbotx.hooks.events.ListenerExceptionEvent
 
toString() - Method in class org.pircbotx.hooks.events.MessageEvent
 
toString() - Method in class org.pircbotx.hooks.events.ModeEvent
 
toString() - Method in class org.pircbotx.hooks.events.MotdEvent
 
toString() - Method in class org.pircbotx.hooks.events.NickAlreadyInUseEvent
 
toString() - Method in class org.pircbotx.hooks.events.NickChangeEvent
 
toString() - Method in class org.pircbotx.hooks.events.NoticeEvent
 
toString() - Method in class org.pircbotx.hooks.events.OpEvent
 
toString() - Method in class org.pircbotx.hooks.events.OutputEvent
 
toString() - Method in class org.pircbotx.hooks.events.OwnerEvent
 
toString() - Method in class org.pircbotx.hooks.events.PartEvent
 
toString() - Method in class org.pircbotx.hooks.events.PingEvent
 
toString() - Method in class org.pircbotx.hooks.events.PrivateMessageEvent
 
toString() - Method in class org.pircbotx.hooks.events.QuitEvent
 
toString() - Method in class org.pircbotx.hooks.events.RemoveChannelBanEvent
 
toString() - Method in class org.pircbotx.hooks.events.RemoveChannelKeyEvent
 
toString() - Method in class org.pircbotx.hooks.events.RemoveChannelLimitEvent
 
toString() - Method in class org.pircbotx.hooks.events.RemoveInviteOnlyEvent
 
toString() - Method in class org.pircbotx.hooks.events.RemoveModeratedEvent
 
toString() - Method in class org.pircbotx.hooks.events.RemoveNoExternalMessagesEvent
 
toString() - Method in class org.pircbotx.hooks.events.RemovePrivateEvent
 
toString() - Method in class org.pircbotx.hooks.events.RemoveSecretEvent
 
toString() - Method in class org.pircbotx.hooks.events.RemoveTopicProtectionEvent
 
toString() - Method in class org.pircbotx.hooks.events.ServerPingEvent
 
toString() - Method in class org.pircbotx.hooks.events.ServerResponseEvent
 
toString() - Method in class org.pircbotx.hooks.events.SetChannelBanEvent
 
toString() - Method in class org.pircbotx.hooks.events.SetChannelKeyEvent
 
toString() - Method in class org.pircbotx.hooks.events.SetChannelLimitEvent
 
toString() - Method in class org.pircbotx.hooks.events.SetInviteOnlyEvent
 
toString() - Method in class org.pircbotx.hooks.events.SetModeratedEvent
 
toString() - Method in class org.pircbotx.hooks.events.SetNoExternalMessagesEvent
 
toString() - Method in class org.pircbotx.hooks.events.SetPrivateEvent
 
toString() - Method in class org.pircbotx.hooks.events.SetSecretEvent
 
toString() - Method in class org.pircbotx.hooks.events.SetTopicProtectionEvent
 
toString() - Method in class org.pircbotx.hooks.events.SocketConnectEvent
 
toString() - Method in class org.pircbotx.hooks.events.SuperOpEvent
 
toString() - Method in class org.pircbotx.hooks.events.TimeEvent
 
toString() - Method in class org.pircbotx.hooks.events.TopicEvent
 
toString() - Method in class org.pircbotx.hooks.events.UnknownEvent
 
toString() - Method in class org.pircbotx.hooks.events.UserListEvent
 
toString() - Method in class org.pircbotx.hooks.events.UserModeEvent
 
toString() - Method in class org.pircbotx.hooks.events.VersionEvent
 
toString() - Method in class org.pircbotx.hooks.events.VoiceEvent
 
toString() - Method in class org.pircbotx.hooks.events.WhoisEvent.Builder
 
toString() - Method in class org.pircbotx.hooks.managers.SequentialListenerManager.SequentialListenerManagerBuilder
 
toString() - Method in class org.pircbotx.PircBotX
Returns a String representation of this object.
toString() - Method in class org.pircbotx.ServerInfo
 
toString() - Method in class org.pircbotx.snapshot.UserSnapshot
 
toString() - Method in class org.pircbotx.User
 
toString() - Method in class org.pircbotx.UserHostmask
 
toString() - Method in class org.pircbotx.UtilSSLSocketFactory
 
transfer() - Method in class org.pircbotx.dcc.FileTransfer
Transfer the file to the user
trustAllCertificates() - Method in class org.pircbotx.UtilSSLSocketFactory
By default, trust ALL certificates.
TrustingX509TrustManager() - Constructor for class org.pircbotx.UtilSSLSocketFactory.TrustingX509TrustManager
 
tryGetIndex(List<V>, int, V) - Static method in class org.pircbotx.Utils
 
tryParseInt(String, int) - Static method in class org.pircbotx.Utils
Try to parse int string, returning -1 if it fails.
tryParseLong(String, int) - Static method in class org.pircbotx.Utils
Try to parse long string, returning -1 if it fails.

U

unBan(String) - Method in class org.pircbotx.output.OutputChannel
Unbans a user from a channel.
UNDERLINE - Static variable in class org.pircbotx.Colors
Underlined text.
unescapeV3TagValue(String) - Static method in class org.pircbotx.Utils
Unescape IRCv3 message tag values which have been escaped before (e.g.
UnknownEvent - Class in org.pircbotx.hooks.events
This event is dispatched whenever we receive a line from the server that PircBotX has not been programmed to recognize.
UnknownEvent(PircBotX, String, String, String, String, List<String>, ImmutableMap<String, String>) - Constructor for class org.pircbotx.hooks.events.UnknownEvent
 
UnknownEventException - Exception in org.pircbotx.exception
An unknown event error.
UnknownEventException(Event, Throwable) - Constructor for exception org.pircbotx.exception.UnknownEventException
 
UnknownEventException(Event) - Constructor for exception org.pircbotx.exception.UnknownEventException
 
updateExecutor(Listener, SequentialListenerManager.ListenerExecutor) - Method in class org.pircbotx.hooks.managers.SequentialListenerManager
Replace the executor for the supplied listener
updateExecutorAllInline() - Method in class org.pircbotx.hooks.managers.SequentialListenerManager
Replace all executors with the inline executor
User - Class in org.pircbotx
Represents a User on the server.
UserChannelDao<U extends User,C extends Channel> - Class in org.pircbotx
Model that creates and tracks Users and Channel and maintains relationships.
UserChannelDaoSnapshot - Class in org.pircbotx.snapshot
 
UserChannelDaoSnapshot(PircBotX, Locale, UserChannelMapSnapshot, EnumMap<UserLevel, UserChannelMap<UserSnapshot, ChannelSnapshot>>, ImmutableMap<String, UserSnapshot>, ImmutableMap<String, ChannelSnapshot>, ImmutableMap<String, UserSnapshot>) - Constructor for class org.pircbotx.snapshot.UserChannelDaoSnapshot
 
UserChannelMap<U extends User,C extends Channel> - Class in org.pircbotx
A many to many map of users to channels.
UserChannelMap() - Constructor for class org.pircbotx.UserChannelMap
Create with HashMultimaps.
UserChannelMapSnapshot - Class in org.pircbotx.snapshot
 
UserChannelMapSnapshot(Multimap<UserSnapshot, ChannelSnapshot>, Multimap<ChannelSnapshot, UserSnapshot>) - Constructor for class org.pircbotx.snapshot.UserChannelMapSnapshot
 
userExists(String) - Method in class org.pircbotx.UserChannelDao
Deprecated.
Renamed UserChannelDao.containsUser(java.lang.String) to match Java Collections API
UserHostmask - Class in org.pircbotx
Represents any hostmask that may or may not be an actual user.
UserLevel - Enum in org.pircbotx
An enum to represent the possible IRC levels a user can have.
UserListEvent - Class in org.pircbotx.hooks.events
This event is dispatched when we receive a user list from the server after joining a channel.
UserListEvent(PircBotX, Channel, ImmutableSortedSet<User>, boolean) - Constructor for class org.pircbotx.hooks.events.UserListEvent
 
UserModeEvent - Class in org.pircbotx.hooks.events
Called when the mode of a user is set.
UserModeEvent(PircBotX, UserHostmask, User, UserHostmask, User, String) - Constructor for class org.pircbotx.hooks.events.UserModeEvent
 
UserSnapshot - Class in org.pircbotx.snapshot
A snapshot of a user in time.
UserSnapshot(User) - Constructor for class org.pircbotx.snapshot.UserSnapshot
 
Utils - Class in org.pircbotx
Useful utilities for internal PircBotX use.
UtilSSLSocketFactory - Class in org.pircbotx
Utility for doing various useful things to an SSL socket factory.
UtilSSLSocketFactory() - Constructor for class org.pircbotx.UtilSSLSocketFactory
 
UtilSSLSocketFactory.TrustingX509TrustManager - Class in org.pircbotx
X509TrustManager that trusts all certificates.

V

valueOf(String) - Static method in enum org.pircbotx.dcc.DccState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.pircbotx.exception.CAPException.Reason
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.pircbotx.exception.DaoException.Reason
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.pircbotx.exception.DccException.Reason
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.pircbotx.exception.IrcException.Reason
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.pircbotx.PircBotX.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.pircbotx.UserLevel
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.pircbotx.dcc.DccState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.pircbotx.exception.CAPException.Reason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.pircbotx.exception.DaoException.Reason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.pircbotx.exception.DccException.Reason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.pircbotx.exception.IrcException.Reason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.pircbotx.PircBotX.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.pircbotx.UserLevel
Returns an array containing the constants of this enum type, in the order they are declared.
VERSION - Static variable in class org.pircbotx.PircBotX
The definitive version number of this release of PircBotX.
VersionEvent - Class in org.pircbotx.hooks.events
This event is dispatched whenever we receive a VERSION request.
VersionEvent(PircBotX, UserHostmask, User, Channel) - Constructor for class org.pircbotx.hooks.events.VersionEvent
 
voice(UserHostmask) - Method in class org.pircbotx.output.OutputChannel
Grants voice privileges to a user on a channel.
VoiceEvent - Class in org.pircbotx.hooks.events
Called when a user (possibly us) gets voice status granted in a channel.
VoiceEvent(PircBotX, Channel, UserHostmask, User, UserHostmask, User, boolean) - Constructor for class org.pircbotx.hooks.events.VoiceEvent
 

W

waitFor(Class<E>) - Method in class org.pircbotx.hooks.WaitForQueue
Wait indefinitely for the specified event to be dispatched
waitFor(Class<? extends E>...) - Method in class org.pircbotx.hooks.WaitForQueue
Wait indefinitely for the one of the specified events to be dispatched
waitFor(List<Class<? extends E>>) - Method in class org.pircbotx.hooks.WaitForQueue
Wait indefinitely for the one of the specified events to be dispatched
waitFor(Class<E>, long, TimeUnit) - Method in class org.pircbotx.hooks.WaitForQueue
 
waitFor(List<Class<? extends E>>, long, TimeUnit) - Method in class org.pircbotx.hooks.WaitForQueue
Wait for events of the specified event class to appear in the queue.
WaitForQueue - Class in org.pircbotx.hooks
Stores all events in a queue for processing.
WaitForQueue(PircBotX) - Constructor for class org.pircbotx.hooks.WaitForQueue
Create and store a queue listener in the specified bot's ListenerManager.
WHITE - Static variable in class org.pircbotx.Colors
White coloured text.
who() - Method in class org.pircbotx.output.OutputChannel
 
whois(String) - Method in class org.pircbotx.output.OutputIRC
Send "WHOIS target"
whois() - Method in class org.pircbotx.output.OutputUser
Send "WHOIS nick"
whoisDetail(String) - Method in class org.pircbotx.output.OutputIRC
Send "WHOIS target target" for more detail
whoisDetail() - Method in class org.pircbotx.output.OutputUser
Send "WHOIS nick nick" for more detail
WhoisEvent - Class in org.pircbotx.hooks.events
Dispatched when we receive a completed Whois request.
WhoisEvent.Builder - Class in org.pircbotx.hooks.events
Internal class to allow data to be collected over multiple lines

Y

YELLOW - Static variable in class org.pircbotx.Colors
Yellow coloured text.
A B C D E F G H I J K L M N O P Q R S T U V W Y 
Skip navigation links

Copyright © 2010–2020 Leon Blakey. All rights reserved.