PircBot Java IRC Bot

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

## A

accept() - Method in class org.jibble.pircbot.DccChat
  Accept this DccChat connection.
add(Object) - Method in class org.jibble.pircbot.Queue
  Adds an Object to the end of the Queue.
addFront(Object) - Method in class org.jibble.pircbot.Queue
  Adds an Object to the front of the Queue.

## B

BLACK - Static variable in class org.jibble.pircbot.Colors
  Black coloured text.
BLUE - Static variable in class org.jibble.pircbot.Colors
  Blue coloured text.
BOLD - Static variable in class org.jibble.pircbot.Colors
  Bold text.
BROWN - Static variable in class org.jibble.pircbot.Colors
  Brown coloured text.
BUFFER_SIZE - Static variable in class org.jibble.pircbot.DccFileTransfer
  The default buffer size to use when sending and receiving files.
ban(String, String) - Method in class org.jibble.pircbot.PircBot
  Bans a user from a channel.

## C

CYAN - Static variable in class org.jibble.pircbot.Colors
  Cyan coloured text.
Colors - class org.jibble.pircbot.Colors.
  The Colors class provides several static fields and methods that you may find useful when writing an IRC Bot.
changeNick(String) - Method in class org.jibble.pircbot.PircBot
  Attempt to change the current nick (nickname) of the bot when it is connected to an IRC server.
clear() - Method in class org.jibble.pircbot.Queue
  Clears the contents of the Queue.
close() - Method in class org.jibble.pircbot.DccChat
  Closes the DCC Chat connection.
close() - Method in class org.jibble.pircbot.DccFileTransfer
  Stops the DCC file transfer by closing the connection.
compareTo(Object) - Method in class org.jibble.pircbot.User
  Returns the result of calling the compareTo method on lowercased nicks.
connect(String) - Method in class org.jibble.pircbot.PircBot
  Attempt to connect to the specified IRC server.
connect(String, int) - Method in class org.jibble.pircbot.PircBot
  Attempt to connect to the specified IRC server and port number.
connect(String, int, String) - Method in class org.jibble.pircbot.PircBot
  Attempt to connect to the specified IRC server using the supplied password.

## D

DARK_BLUE - Static variable in class org.jibble.pircbot.Colors
  Dark blue coloured text.
DARK_GRAY - Static variable in class org.jibble.pircbot.Colors
  Dark gray coloured text.
DARK_GREEN - Static variable in class org.jibble.pircbot.Colors
  Dark green coloured text.
DccChat - class org.jibble.pircbot.DccChat.
  This class is used to allow the bot to interact with a DCC Chat session.
DccFileTransfer - class org.jibble.pircbot.DccFileTransfer.
  This class is used to administer a DCC file transfer.
DccManager - class org.jibble.pircbot.DccManager.
  This class is used to process DCC events from the server.
dccAcceptChatRequest(String, long, int) - Method in class org.jibble.pircbot.PircBot
  Deprecated. As of PircBot 1.2.0, use `PircBot.onIncomingChatRequest(DccChat)`
dccReceiveFile(File, long, int, int) - Method in class org.jibble.pircbot.PircBot
  Deprecated. As of PircBot 1.2.0, use `PircBot.onIncomingFileTransfer(DccFileTransfer)`
dccSendChatRequest(String, int) - Method in class org.jibble.pircbot.PircBot
  Attempts to establish a DCC CHAT session with a client.
dccSendFile(File, String, int) - Method in class org.jibble.pircbot.PircBot
  Sends a file to another user.
deOp(String, String) - Method in class org.jibble.pircbot.PircBot
  Removes operator privilidges from a user on a channel.
deVoice(String, String) - Method in class org.jibble.pircbot.PircBot
  Removes voice privilidges from a user on a channel.
disconnect() - Method in class org.jibble.pircbot.PircBot
  This method disconnects from the server cleanly by calling the quitServer() method.
dispose() - Method in class org.jibble.pircbot.InputThread
  Closes the socket without onDisconnect being called subsequently.
dispose() - Method in class org.jibble.pircbot.PircBot
  Disposes of all thread resources used by this PircBot.

## E

ERR_ALREADYREGISTRED - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_BADCHANMASK - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_BADCHANNELKEY - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_BANNEDFROMCHAN - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_CANNOTSENDTOCHAN - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_CANTKILLSERVER - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_CHANNELISFULL - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_CHANOPRIVSNEEDED - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_ERRONEUSNICKNAME - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_FILEERROR - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_INVITEONLYCHAN - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_KEYSET - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NEEDMOREPARAMS - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NICKCOLLISION - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NICKNAMEINUSE - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NOADMININFO - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NOLOGIN - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NOMOTD - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NONICKNAMEGIVEN - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NOOPERHOST - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NOORIGIN - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NOPERMFORHOST - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NOPRIVILEGES - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NORECIPIENT - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NOSERVICEHOST - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NOSUCHCHANNEL - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NOSUCHNICK - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NOSUCHSERVER - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NOTEXTTOSEND - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NOTONCHANNEL - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NOTOPLEVEL - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_NOTREGISTERED - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_PASSWDMISMATCH - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_SUMMONDISABLED - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_TOOMANYCHANNELS - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_TOOMANYTARGETS - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_UMODEUNKNOWNFLAG - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_UNKNOWNCOMMAND - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_UNKNOWNMODE - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_USERNOTINCHANNEL - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_USERONCHANNEL - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_USERSDISABLED - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_USERSDONTMATCH - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_WASNOSUCHNICK - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_WILDTOPLEVEL - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_YOUREBANNEDCREEP - Static variable in interface org.jibble.pircbot.ReplyConstants
ERR_YOUWILLBEBANNED - Static variable in interface org.jibble.pircbot.ReplyConstants
equals(Object) - Method in class org.jibble.pircbot.PircBot
  Returns true if and only if the object being compared is the exact same instance as this PircBot.
equals(String) - Method in class org.jibble.pircbot.User
  Returns true if the nick represented by this User object is the same as the argument.
equals(Object) - Method in class org.jibble.pircbot.User
  Returns true if the nick represented by this User object is the same as the nick of the User object given as an argument.

## G

GREEN - Static variable in class org.jibble.pircbot.Colors
  Green coloured text.
getBufferedReader() - Method in class org.jibble.pircbot.DccChat
  Returns the BufferedReader used by this DCC Chat.
getBufferedWriter() - Method in class org.jibble.pircbot.DccChat
  Returns the BufferedReader used by this DCC Chat.
getChannels() - Method in class org.jibble.pircbot.PircBot
  Returns an array of all channels that we are in.
getDccInetAddress() - Method in class org.jibble.pircbot.PircBot
  Returns the InetAddress used when sending DCC chat or file transfers.
getDccPorts() - Method in class org.jibble.pircbot.PircBot
  Returns the set of port numbers to be used when sending a DCC chat or file transfer.
getEncoding() - Method in class org.jibble.pircbot.PircBot
  Returns the encoding used to send and receive lines from the IRC server, or null if not set.
getFile() - Method in class org.jibble.pircbot.DccFileTransfer
  Returns the suggested file to be used for this transfer.
getFinger() - Method in class org.jibble.pircbot.PircBot
  Gets the internal finger message of the PircBot.
getHostname() - Method in class org.jibble.pircbot.DccChat
  Returns the hostname of the DCC Chat initiator.
getHostname() - Method in class org.jibble.pircbot.DccFileTransfer
  Returns the hostname of the file sender.
getInetAddress() - Method in class org.jibble.pircbot.PircBot
  Returns the InetAddress used by the PircBot.
getLogin() - Method in class org.jibble.pircbot.DccChat
  Returns the login of the DCC Chat initiator.
getLogin() - Method in class org.jibble.pircbot.DccFileTransfer
  Returns the login of the file sender.
getLogin() - Method in class org.jibble.pircbot.PircBot
  Gets the internal login of the PircBot.
getMaxLineLength() - Method in class org.jibble.pircbot.PircBot
  Gets the maximum length of any line that is sent via the IRC protocol.
getMessageDelay() - Method in class org.jibble.pircbot.PircBot
  Returns the number of milliseconds that will be used to separate consecutive messages to the server from the outgoing message queue.
getName() - Method in class org.jibble.pircbot.PircBot
  Gets the name of the PircBot.
getNick() - Method in class org.jibble.pircbot.DccChat
  Returns the nick of the other user taking part in this file transfer.
getNick() - Method in class org.jibble.pircbot.DccFileTransfer
  Returns the nick of the other user taking part in this file transfer.
getNick() - Method in class org.jibble.pircbot.PircBot
  Returns the current nick of the bot.
getNick() - Method in class org.jibble.pircbot.User
  Returns the nick of the user.
getNumericalAddress() - Method in class org.jibble.pircbot.DccChat
  Returns the address of the sender as a long.
getNumericalAddress() - Method in class org.jibble.pircbot.DccFileTransfer
  Returns the address of the sender as a long.
getOutgoingQueueSize() - Method in class org.jibble.pircbot.PircBot
  Gets the number of lines currently waiting in the outgoing message Queue.
getPacketDelay() - Method in class org.jibble.pircbot.DccFileTransfer
  returns the delay time between each packet that is send or received.
getPassword() - Method in class org.jibble.pircbot.PircBot
  Returns the last password that we used when connecting to an IRC server.
getPort() - Method in class org.jibble.pircbot.DccFileTransfer
  Returns the port number to be used when making the connection.
getPort() - Method in class org.jibble.pircbot.PircBot
  Returns the port number of the last IRC server that the PircBot tried to connect to.
getPrefix() - Method in class org.jibble.pircbot.User
  Returns the prefix of the user.
getProgress() - Method in class org.jibble.pircbot.DccFileTransfer
  Returns the progress (in bytes) of the current file transfer.
getProgressPercentage() - Method in class org.jibble.pircbot.DccFileTransfer
  Returns the progress of the file transfer as a percentage.
getServer() - Method in class org.jibble.pircbot.PircBot
  Returns the name of the last IRC server the PircBot tried to connect to.
getSize() - Method in class org.jibble.pircbot.DccFileTransfer
  Returns the size (in bytes) of the file being transfered.
getSocket() - Method in class org.jibble.pircbot.DccChat
  Returns the raw Socket used by this DCC Chat.
getTransferRate() - Method in class org.jibble.pircbot.DccFileTransfer
  Returns the rate of data transfer in bytes per second.
getUsers(String) - Method in class org.jibble.pircbot.PircBot
  Returns an array of all users in the specified channel.
getVersion() - Method in class org.jibble.pircbot.PircBot
  Gets the internal version of the PircBot.

## H

handleLine(String) - Method in class org.jibble.pircbot.PircBot
  This method handles events when any line of text arrives from the server, then calling the appropriate method in the PircBot.
hasNext() - Method in class org.jibble.pircbot.Queue
  Returns true if the Queue is not empty.
hasVoice() - Method in class org.jibble.pircbot.User
  Returns whether or not the user represented by this object has voice.
hashCode() - Method in class org.jibble.pircbot.PircBot
  Returns the hashCode of this PircBot.
hashCode() - Method in class org.jibble.pircbot.User
  Returns the hash code of this User object.

## I

IdentServer - class org.jibble.pircbot.IdentServer.
  A simple IdentServer (also know as "The Identification Protocol").
InputThread - class org.jibble.pircbot.InputThread.
  A Thread which reads lines from the IRC server.
IrcException - exception org.jibble.pircbot.IrcException.
  An IrcException class.
IrcException(String) - Constructor for class org.jibble.pircbot.IrcException
  Constructs a new IrcException.
identify(String) - Method in class org.jibble.pircbot.PircBot
  Identify the bot with NickServ, supplying the appropriate password.
ipToLong(byte[]) - Method in class org.jibble.pircbot.PircBot
  A convenient method that accepts an IP address represented by a byte[] of size 4 and returns this as a long representation of the same IP address.
isConnected() - Method in class org.jibble.pircbot.PircBot
  Returns whether or not the PircBot is currently connected to a server.
isIncoming() - Method in class org.jibble.pircbot.DccFileTransfer
  Returns true if the file transfer is incoming (somebody is sending the file to us).
isOp() - Method in class org.jibble.pircbot.User
  Returns whether or not the user represented by this object is an operator.
isOutgoing() - Method in class org.jibble.pircbot.DccFileTransfer
  Returns true if the file transfer is outgoing (we are sending the file to someone).

## J

joinChannel(String) - Method in class org.jibble.pircbot.PircBot
  Joins a channel.
joinChannel(String, String) - Method in class org.jibble.pircbot.PircBot
  Joins a channel with a key.

## K

kick(String, String) - Method in class org.jibble.pircbot.PircBot
  Kicks a user from a channel.
kick(String, String, String) - Method in class org.jibble.pircbot.PircBot
  Kicks a user from a channel, giving a reason.

## L

LIGHT_GRAY - Static variable in class org.jibble.pircbot.Colors
  Light gray coloured text.
listChannels() - Method in class org.jibble.pircbot.PircBot
  Issues a request for a list of all channels on the IRC server.
listChannels(String) - Method in class org.jibble.pircbot.PircBot
  Issues a request for a list of all channels on the IRC server.
log(String) - Method in class org.jibble.pircbot.PircBot
  Adds a line to the log.
longToIp(long) - Method in class org.jibble.pircbot.PircBot
  A convenient method that accepts an IP address represented as a long and returns an integer array of size 4 representing the same IP address.

## M

MAGENTA - Static variable in class org.jibble.pircbot.Colors
  Magenta coloured text.
MAX_LINE_LENGTH - Static variable in class org.jibble.pircbot.InputThread

## N

NORMAL - Static variable in class org.jibble.pircbot.Colors
  Removes all previously applied color and formatting attributes.
NickAlreadyInUseException - exception org.jibble.pircbot.NickAlreadyInUseException.
  A NickAlreadyInUseException class.
NickAlreadyInUseException(String) - Constructor for class org.jibble.pircbot.NickAlreadyInUseException
  Constructs a new IrcException.
next() - Method in class org.jibble.pircbot.Queue
  Returns the Object at the front of the Queue.

## O

OLIVE - Static variable in class org.jibble.pircbot.Colors
  Olive coloured text.
OutputThread - class org.jibble.pircbot.OutputThread.
  A Thread which is responsible for sending messages to the IRC server.
onAction(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever an ACTION is sent from a user.
onChannelInfo(String, int, String) - Method in class org.jibble.pircbot.PircBot
  After calling the listChannels() method in PircBot, the server will start to send us information about each channel on the server.
onConnect() - Method in class org.jibble.pircbot.PircBot
  This method is called once the PircBot has successfully connected to the IRC server.
onDccChatRequest(String, String, String, long, int) - Method in class org.jibble.pircbot.PircBot
  Deprecated. As of PircBot 1.2.0, use `PircBot.onIncomingChatRequest(DccChat)`
onDccSendRequest(String, String, String, String, long, int, int) - Method in class org.jibble.pircbot.PircBot
  Deprecated. As of PircBot 1.2.0, use `PircBot.onIncomingFileTransfer(DccFileTransfer)`
onDeVoice(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a user (possibly us) gets voice status removed.
onDeop(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a user (possibly us) gets operator status taken away.
onDisconnect() - Method in class org.jibble.pircbot.PircBot
  This method carries out the actions to be performed when the PircBot gets disconnected.
onFileTransferFinished(DccFileTransfer, Exception) - Method in class org.jibble.pircbot.PircBot
  This method gets called when a DccFileTransfer has finished.
onFinger(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever we receive a FINGER request.
onIncomingChatRequest(DccChat) - Method in class org.jibble.pircbot.PircBot
  This method will be called whenever a DCC Chat request is received.
onIncomingFileTransfer(DccFileTransfer) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever a DCC SEND request is sent to the PircBot.
onInvite(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when we are invited to a channel by a user.
onJoin(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever someone (possibly us) joins a channel which we are on.
onKick(String, String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever someone (possibly us) is kicked from any of the channels that we are in.
onMessage(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever a message is sent to a channel.
onMode(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when the mode of a channel is set.
onNickChange(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever someone (possibly us) changes nick on any of the channels that we are on.
onNotice(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever we receive a notice.
onOp(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a user (possibly us) gets granted operator status for a channel.
onPart(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever someone (possibly us) parts a channel which we are on.
onPing(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever we receive a PING request from another user.
onPrivateMessage(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever a private message is sent to the PircBot.
onQuit(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever someone (possibly us) quits from the server.
onRemoveChannelBan(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a hostmask ban is removed from a channel.
onRemoveChannelKey(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel key is removed.
onRemoveChannelLimit(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when the user limit is removed for a channel.
onRemoveInviteOnly(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel has 'invite only' removed.
onRemoveModerated(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel has moderated mode removed.
onRemoveNoExternalMessages(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel is set to allow messages from any user, even if they are not actually in the channel.
onRemovePrivate(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel is marked as not being in private mode.
onRemoveSecret(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel has 'secret' mode removed.
onRemoveTopicProtection(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when topic protection is removed for a channel.
onServerPing(String) - Method in class org.jibble.pircbot.PircBot
  The actions to perform when a PING request comes from the server.
onServerResponse(int, String) - Method in class org.jibble.pircbot.PircBot
  This method is called when we receive a numeric response from the IRC server.
onSetChannelBan(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a user (possibly us) gets banned from a channel.
onSetChannelKey(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel key is set.
onSetChannelLimit(String, String, String, String, int) - Method in class org.jibble.pircbot.PircBot
  Called when a user limit is set for a channel.
onSetInviteOnly(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel is set to 'invite only' mode.
onSetModerated(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel is set to 'moderated' mode.
onSetNoExternalMessages(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel is set to only allow messages from users that are in the channel.
onSetPrivate(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel is marked as being in private mode.
onSetSecret(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel is set to be in 'secret' mode.
onSetTopicProtection(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when topic protection is enabled for a channel.
onTime(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever we receive a TIME request.
onTopic(String, String) - Method in class org.jibble.pircbot.PircBot
  Deprecated. As of 1.2.0, replaced by `PircBot.onTopic(String,String,String,long,boolean)`
onTopic(String, String, String, long, boolean) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever a user sets the topic, or when PircBot joins a new channel and discovers its topic.
onUnknown(String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever we receive a line from the server that the PircBot has not been programmed to recognise.
onUserList(String, User[]) - Method in class org.jibble.pircbot.PircBot
  This method is called when we receive a user list from the server after joining a channel.
onUserMode(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when the mode of a user is set.
onVersion(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever we receive a VERSION request.
onVoice(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a user (possibly us) gets voice status granted in a channel.
op(String, String) - Method in class org.jibble.pircbot.PircBot
  Grants operator privilidges to a user on a channel.
org.jibble.pircbot - package org.jibble.pircbot

## P

PURPLE - Static variable in class org.jibble.pircbot.Colors
  Purple coloured text.
PircBot - class org.jibble.pircbot.PircBot.
  PircBot is a Java framework for writing IRC bots quickly and easily.
PircBot() - Constructor for class org.jibble.pircbot.PircBot
  Constructs a PircBot with the default settings.
partChannel(String) - Method in class org.jibble.pircbot.PircBot
  Parts a channel.
partChannel(String, String) - Method in class org.jibble.pircbot.PircBot
  Parts a channel, giving a reason.

## Q

Queue - class org.jibble.pircbot.Queue.
  Queue is a definition of a data structure that may act as a queue - that is, data can be added to one end of the queue and data can be requested from the head end of the queue.
Queue() - Constructor for class org.jibble.pircbot.Queue
  Constructs a Queue object of unlimited size.
quitServer() - Method in class org.jibble.pircbot.PircBot
  Quits from the IRC server.
quitServer(String) - Method in class org.jibble.pircbot.PircBot
  Quits from the IRC server with a reason.

## R

RED - Static variable in class org.jibble.pircbot.Colors
  Red coloured text.
REVERSE - Static variable in class org.jibble.pircbot.Colors
  Reversed text (may be rendered as italic text in some clients).
RPL_ADMINEMAIL - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_ADMINLOC1 - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_ADMINLOC2 - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_ADMINME - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_AWAY - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_BANLIST - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_CHANNELMODEIS - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_CLOSEEND - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_CLOSING - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_ENDOFBANLIST - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_ENDOFINFO - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_ENDOFLINKS - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_ENDOFMOTD - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_ENDOFNAMES - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_ENDOFSERVICES - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_ENDOFSTATS - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_ENDOFUSERS - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_ENDOFWHO - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_ENDOFWHOIS - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_ENDOFWHOWAS - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_INFO - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_INFOSTART - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_INVITING - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_ISON - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_KILLDONE - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_LINKS - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_LIST - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_LISTEND - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_LISTSTART - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_LUSERCHANNELS - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_LUSERCLIENT - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_LUSERME - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_LUSEROP - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_LUSERUNKNOWN - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_MOTD - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_MOTDSTART - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_MYPORTIS - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_NAMREPLY - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_NONE - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_NOTOPIC - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_NOUSERS - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_NOWAWAY - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_REHASHING - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_SERVICE - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_SERVICEINFO - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_SERVLIST - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_SERVLISTEND - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_STATSCLINE - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_STATSCOMMANDS - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_STATSHLINE - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_STATSILINE - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_STATSKLINE - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_STATSLINKINFO - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_STATSLLINE - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_STATSNLINE - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_STATSOLINE - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_STATSQLINE - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_STATSUPTIME - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_STATSYLINE - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_SUMMONING - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_TIME - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_TOPIC - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_TOPICINFO - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_TRACECLASS - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_TRACECONNECTING - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_TRACEHANDSHAKE - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_TRACELINK - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_TRACELOG - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_TRACENEWTYPE - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_TRACEOPERATOR - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_TRACESERVER - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_TRACEUNKNOWN - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_TRACEUSER - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_UMODEIS - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_UNAWAY - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_USERHOST - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_USERS - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_USERSSTART - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_VERSION - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_WHOISCHANNELS - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_WHOISCHANOP - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_WHOISIDLE - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_WHOISOPERATOR - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_WHOISSERVER - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_WHOISUSER - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_WHOREPLY - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_WHOWASUSER - Static variable in interface org.jibble.pircbot.ReplyConstants
RPL_YOUREOPER - Static variable in interface org.jibble.pircbot.ReplyConstants
ReplyConstants - interface org.jibble.pircbot.ReplyConstants.
  This interface contains the values of all numeric replies specified in section 6 of RFC 1459.
readLine() - Method in class org.jibble.pircbot.DccChat
  Reads the next line of text from the client at the other end of our DCC Chat connection.
receive(File, boolean) - Method in class org.jibble.pircbot.DccFileTransfer
  Receives a DccFileTransfer and writes it to the specified file.
reconnect() - Method in class org.jibble.pircbot.PircBot
  Reconnects to the IRC server that we were previously connected to.
removeColors(String) - Static method in class org.jibble.pircbot.Colors
  Removes all colours from a line of IRC text.
removeFormatting(String) - Static method in class org.jibble.pircbot.Colors
  Remove formatting from a line of IRC text.
removeFormattingAndColors(String) - Static method in class org.jibble.pircbot.Colors
  Removes all formatting and colours from a line of IRC text.
run() - Method in class org.jibble.pircbot.IdentServer
  Waits for a client to connect to the ident server before making an appropriate response.
run() - Method in class org.jibble.pircbot.InputThread
  Called to start this Thread reading lines from the IRC server.
run() - Method in class org.jibble.pircbot.OutputThread
  This method starts the Thread consuming from the outgoing message Queue and sending lines to the server.

## S

sendAction(String, String) - Method in class org.jibble.pircbot.PircBot
  Sends an action to the channel or to a user.
sendCTCPCommand(String, String) - Method in class org.jibble.pircbot.PircBot
  Sends a CTCP command to a channel or user.
sendInvite(String, String) - Method in class org.jibble.pircbot.PircBot
  Sends an invitation to join a channel.
sendLine(String) - Method in class org.jibble.pircbot.DccChat
  Sends a line of text to the client at the other end of our DCC Chat connection.
sendMessage(String, String) - Method in class org.jibble.pircbot.PircBot
  Sends a message to a channel or a private message to a user.
sendNotice(String, String) - Method in class org.jibble.pircbot.PircBot
  Sends a notice to the channel or to a user.
sendRawLine(String) - Method in class org.jibble.pircbot.PircBot
  Sends a raw line to the IRC server as soon as possible, bypassing the outgoing message queue.
sendRawLineViaQueue(String) - Method in class org.jibble.pircbot.PircBot
  Sends a raw line through the outgoing message queue.
setAutoNickChange(boolean) - Method in class org.jibble.pircbot.PircBot
  When you connect to a server and your nick is already in use and this is set to true, a new nick will be automatically chosen.
setDccInetAddress(InetAddress) - Method in class org.jibble.pircbot.PircBot
  Sets the InetAddress to be used when sending DCC chat or file transfers.
setDccPorts(int[]) - Method in class org.jibble.pircbot.PircBot
  Sets the choice of port numbers that can be used when sending a DCC chat or file transfer.
setEncoding(String) - Method in class org.jibble.pircbot.PircBot
  Sets the encoding charset to be used when sending or receiving lines from the IRC server.
setFinger(String) - Method in class org.jibble.pircbot.PircBot
  Sets the interal finger message.
setLogin(String) - Method in class org.jibble.pircbot.PircBot
  Sets the internal login of the Bot.
setMessageDelay(long) - Method in class org.jibble.pircbot.PircBot
  Sets the number of milliseconds to delay between consecutive messages when there are multiple messages waiting in the outgoing message queue.
setMode(String, String) - Method in class org.jibble.pircbot.PircBot
  Set the mode of a channel.
setName(String) - Method in class org.jibble.pircbot.PircBot
  Sets the name of the bot, which will be used as its nick when it tries to join an IRC server.
setPacketDelay(long) - Method in class org.jibble.pircbot.DccFileTransfer
  Sets the delay time between sending or receiving each packet.
setTopic(String, String) - Method in class org.jibble.pircbot.PircBot
  Set the topic for a channel.
setVerbose(boolean) - Method in class org.jibble.pircbot.PircBot
  Sets the verbose mode.
setVersion(String) - Method in class org.jibble.pircbot.PircBot
  Sets the internal version of the Bot.
size() - Method in class org.jibble.pircbot.Queue
  Returns the size of the Queue.
startIdentServer() - Method in class org.jibble.pircbot.PircBot
  Starts an ident server (Identification Protocol Server, RFC 1413).

## T

TEAL - Static variable in class org.jibble.pircbot.Colors
  Teal coloured text.
toString() - Method in class org.jibble.pircbot.PircBot
  Returns a String representation of this object.
toString() - Method in class org.jibble.pircbot.User
  Returns the nick of the user complete with their prefix if they have one, e.g.

## U

UNDERLINE - Static variable in class org.jibble.pircbot.Colors
  Underlined text.
User - class org.jibble.pircbot.User.
  This class is used to represent a user on an IRC server.
unBan(String, String) - Method in class org.jibble.pircbot.PircBot
  Unbans a user from a channel.

## V

VERSION - Static variable in class org.jibble.pircbot.PircBot
  The definitive version number of this release of PircBot.
voice(String, String) - Method in class org.jibble.pircbot.PircBot
  Grants voice privilidges to a user on a channel.

## W

WHITE - Static variable in class org.jibble.pircbot.Colors
  White coloured text.

## Y

YELLOW - Static variable in class org.jibble.pircbot.Colors
  Yellow coloured text.

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

PircBot Java IRC Bot