net.sourceforge.ppf
Class PPFPlugin

java.lang.Object
  net.sourceforge.ppf.PPFPlugin

public abstract class PPFPlugin
extends java.lang.Object

Author:

MadMan

Field Summary

protected static int	OUTPUT_CHANNEL Output will be sent to the channel
protected static int	OUTPUT_NOTICE Output will be sent as a notice
protected static int	OUTPUT_PM Output will be sent to a private message
protected java.lang.String	PLUGIN_ID Plugin ID
protected java.lang.String	PLUGIN_VERSION Version number of the plugin

Constructor Summary

PPFPlugin()
Constructor

Method Summary

protected boolean	addToItemList(java.lang.String listElem, org.jdom.Element newElement, java.lang.String key, java.lang.String value) Adds a new item to the persitent list.
protected boolean	addToItemList(java.lang.String key, java.lang.String value) Adds a new item to the list in memory.
protected int	authLevelFromString(java.lang.String authLevel) Figure out what the required auth level is.
protected java.lang.String	getAttributeFromDoc(java.lang.String path, java.lang.String attribute) Get an attribute from an element in the document.
protected boolean	getBooleanFromDoc(java.lang.String path) Get the boolean value from a text representation.
PPF	getBot() Returns the instance of PPF that this plugin has been initialised with.
protected org.jdom.Document	getDoc() The JDom Document that is created when reading in the XML config.
protected java.lang.String	getFormattedString(java.lang.String key, java.lang.String defaultValue) read a string from the language ressouce bundle for the default bot language
protected java.lang.String	getFormattedString(java.lang.String key, java.lang.String defaultValue, java.lang.Object[] arguments) read a string from the language ressouce bundle for the default bot language
protected java.lang.String	getFormattedString(java.lang.String language, java.lang.String key, java.lang.String defaultValue) read a language dependent string (without placeholders) from the ressouce bundle
protected java.lang.String	getFormattedString(java.lang.String language, java.lang.String key, java.lang.String defaultValue, java.lang.Object[] arguments) read a language dependent string (with placeholders) from the associated ressource bundle
protected java.lang.String	getFormattedStringFor(java.lang.String sender, java.lang.String key, java.lang.String defaultValue) read a string from the language ressource bundle for the language of the sender
protected java.lang.String	getFormattedStringFor(java.lang.String sender, java.lang.String key, java.lang.String defaultValue, java.lang.Object[] arguments) read a string from the language ressource bundle for the language of the sender
protected java.lang.String	getFromItemList(java.lang.String key) Select a single item from the list by using the key.
protected java.util.HashMap<java.lang.String,PPFHelp>	getHelp() Gets all of the help for this plugin.
protected java.util.HashMap<java.lang.String,java.lang.String>	getItemList() Easy way to keep hold of a list of String items.
protected java.util.List	getListFromDoc(java.lang.String path) Get a list of elements from the Document.
protected PPFResourceBundle	getPPFResourceBundle() A resource bundle that contains all of the available language resource bundles for this plugin.
protected java.lang.String	getTextFromDoc(java.lang.String path) Get text from an XML element.
protected java.lang.String	getUrlStr() The location of where this plugin is running from in URL from.
java.lang.String	getVersion() Gets the version of the plugin.
protected java.lang.String	getXMLFilename() The filename of the XML config that is used by this plugin.
protected void	init(PPF ppf) Called by the core when a plugin is loaded.
protected boolean	isInItemList(java.lang.String key) Check if an item is in the list, by key.
protected org.jdom.Document	loadDoc(java.lang.String filename) Loads an XML document.
protected void	onAction(java.lang.String sender, java.lang.String login, java.lang.String hostname, java.lang.String target, java.lang.String action) JavaDocs for this method are from: PircBot onAction
protected void	onAuth(java.lang.String login, java.lang.String channel) Send info that login has AUTHed with the system and the channel they are in.
protected void	onChannelInfo(java.lang.String channel, int userCount, java.lang.String topic) JavaDocs for this method are from: PircBot onChannelInfo
protected void	onConnect() JavaDocs for this method are from: PircBot onConnect
protected void	onDeop(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, java.lang.String recipient) JavaDocs for this method are from: PircBot onDeop
protected void	onDeVoice(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, java.lang.String recipient) JavaDocs for this method are from: PircBot onDeVoice
protected void	onDisconnect() JavaDocs for this method are from: PircBot onDisconnect
protected void	onFileTransferFinished(org.jibble.pircbot.DccFileTransfer transfer, java.lang.Exception e) JavaDocs for this method are from: PircBot onFileTransferFinished
protected void	onFinger(java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, java.lang.String target) JavaDocs for this method are from: PircBot onFinger
protected void	onIncomingChatRequest(org.jibble.pircbot.DccChat chat) JavaDocs for this method are from: PircBot onIncomingChatRequest
protected void	onIncomingFileTransfer(org.jibble.pircbot.DccFileTransfer transfer) JavaDocs for this method are from: PircBot onIncomingFileTransfer
protected void	onInvite(java.lang.String targetNick, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, java.lang.String channel) JavaDocs for this method are from: PircBot onInvite
protected void	onJoin(java.lang.String channel, java.lang.String sender, java.lang.String login, java.lang.String hostname) JavaDocs for this method are from: PircBot onJoin
protected void	onKick(java.lang.String channel, java.lang.String kickerNick, java.lang.String kickerLogin, java.lang.String kickerHostname, java.lang.String recipientNick, java.lang.String reason) JavaDocs for this method are from: PircBot onKick
protected void	onMessage(java.lang.String channel, java.lang.String sender, java.lang.String login, java.lang.String hostname, java.lang.String message) JavaDocs for this method are from: PircBot onMessage
protected void	onMode(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, java.lang.String mode) JavaDocs for this method are from: PircBot onMode
protected void	onNickChange(java.lang.String oldNick, java.lang.String login, java.lang.String hostname, java.lang.String newNick) JavaDocs for this method are from: PircBot onNickChange
protected void	onNotice(java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, java.lang.String target, java.lang.String notice) JavaDocs for this method are from: PircBot onNotice
protected void	onOp(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, java.lang.String recipient) JavaDocs for this method are from: PircBot onOp
protected void	onPart(java.lang.String channel, java.lang.String sender, java.lang.String login, java.lang.String hostname) JavaDocs for this method are from: PircBot onPart
protected void	onPing(java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, java.lang.String target, java.lang.String pingValue) JavaDocs for this method are from: PircBot onPing
protected void	onPrivateMessage(java.lang.String sender, java.lang.String login, java.lang.String hostname, java.lang.String message) JavaDocs for this method are from: PircBot onPrivateMessage
protected void	onQuit(java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, java.lang.String reason) JavaDocs for this method are from: PircBot onQuit
protected void	onRemoveChannelBan(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, java.lang.String hostmask) JavaDocs for this method are from: PircBot onRemoveChannelBan
protected void	onRemoveChannelKey(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, java.lang.String key) JavaDocs for this method are from: PircBot onRemoveChannelKey
protected void	onRemoveChannelLimit(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname) JavaDocs for this method are from: PircBot onRemoveChannelLimit
protected void	onRemoveInviteOnly(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname) JavaDocs for this method are from: PircBot onRemoveInviteOnly
protected void	onRemoveModerated(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname) JavaDocs for this method are from: PircBot onRemoveModerated
protected void	onRemoveNoExternalMessages(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname) JavaDocs for this method are from: PircBot onRemoveNoExternalMessages
protected void	onRemovePrivate(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname) JavaDocs for this method are from: PircBot onRemovePrivate
protected void	onRemoveSecret(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname) JavaDocs for this method are from: PircBot onRemoveSecret
protected void	onRemoveTopicProtection(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname) JavaDocs for this method are from: PircBot onRemoveTopicProtection
protected void	onServerPing(java.lang.String response) JavaDocs for this method are from: PircBot onServerPing
protected void	onServerResponse(int code, java.lang.String response) JavaDocs for this method are from: PircBot onServerResponse
protected void	onSetChannelBan(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, java.lang.String hostmask) JavaDocs for this method are from: PircBot onSetChannelBan
protected void	onSetChannelKey(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, java.lang.String key) JavaDocs for this method are from: PircBot onSetChannelKey
protected void	onSetChannelLimit(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, int limit) JavaDocs for this method are from: PircBot onSetChannelLimit
protected void	onSetInviteOnly(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname) JavaDocs for this method are from: PircBot onSetInviteOnly
protected void	onSetModerated(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname) JavaDocs for this method are from: PircBot onSetModerated
protected void	onSetNoExternalMessages(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname) JavaDocs for this method are from: PircBot onSetNoExternalMessages
protected void	onSetPrivate(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname) JavaDocs for this method are from: PircBot onSetPrivate
protected void	onSetSecret(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname) JavaDocs for this method are from: PircBot onSetSecret
protected void	onSetTopicProtection(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname) JavaDocs for this method are from: PircBot onSetTopicProtection
protected void	onTime(java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, java.lang.String target) JavaDocs for this method are from: PircBot onTime
protected void	onTopic(java.lang.String channel, java.lang.String topic, java.lang.String setBy, long date, boolean changed) JavaDocs for this method are from: PircBot onTopic
protected void	onUnknown(java.lang.String line) JavaDocs for this method are from: PircBot onUnknown
protected void	onUserList(java.lang.String channel, org.jibble.pircbot.User[] users) JavaDocs for this method are from: PircBot onUserList
protected void	onUserMode(java.lang.String targetNick, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, java.lang.String mode) JavaDocs for this method are from: PircBot onUserMode
protected void	onVersion(java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, java.lang.String target) JavaDocs for this method are from: PircBot onVersion
protected void	onVoice(java.lang.String channel, java.lang.String sourceNick, java.lang.String sourceLogin, java.lang.String sourceHostname, java.lang.String recipient) JavaDocs for this method are from: PircBot onVoice
protected int	outputFromString(java.lang.String output) Figure out where the output will go.
protected void	readProperties(java.lang.String bundleName) Read a set of properties files in for use by this plugin.
protected boolean	removeFromItemList(java.lang.String childElem, java.lang.String xPath, java.lang.String key) Remove an item from the persitent list.
protected boolean	saveDoc() Save the currently loaded XML document.
protected boolean	saveDocAs(java.lang.String newFilename) Save the currently loaded XML document to an alternate file.
void	sendOutput(int output, java.lang.String channel, java.lang.String sender, java.lang.String message) Sends the output to the place that was configured.
protected void	setHelp(java.lang.String command, PPFHelp ppfHelp) Adds online help information for a command in the plugin.
protected void	setVersion(java.lang.String thisVersion) Set the version of the plugin.
protected void	unload() Unload hook to place any clean-up code in - this is called by PPF when unloading the plugin.
protected void	viewItemList(java.lang.String sender) View all items in the list.
protected void	viewItemList(java.lang.String sender, int timeout) View all items in the list.

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_VERSION

protected java.lang.String PLUGIN_VERSION

Version number of the plugin

PLUGIN_ID

protected java.lang.String PLUGIN_ID

Plugin ID

OUTPUT_CHANNEL

protected static final int OUTPUT_CHANNEL

Output will be sent to the channel

See Also:

Constant Field Values

OUTPUT_PM

protected static final int OUTPUT_PM

Output will be sent to a private message

See Also:

Constant Field Values

OUTPUT_NOTICE

protected static final int OUTPUT_NOTICE

Output will be sent as a notice

See Also:

Constant Field Values

Constructor Detail

PPFPlugin

public PPFPlugin()

Constructor

Method Detail

init

protected void init(PPF ppf)

Called by the core when a plugin is loaded. This method is called every time a plugin is loaded, which means at the initial loading and also when a plugin is reloaded (reloading means unload and then load).

Parameters:

ppf - the bot instance used to create this plugin

getBot

public PPF getBot()

Returns the instance of PPF that this plugin has been initialised with.

Returns:

PPF the PPF instance

unload

protected void unload()

Unload hook to place any clean-up code in - this is called by PPF when unloading the plugin.

outputFromString

protected int outputFromString(java.lang.String output)

Figure out where the output will go. Where some commands output to is configurable. This takes the configured text and returns one of the plugin OUTPUT constants.

Parameters:

output - string representation of where the output will go

Returns:

PPF output from the string representation, defaults to OUTPUT_CHANNEL if a value that is not recognised if given

sendOutput

public void sendOutput(int output,
                       java.lang.String channel,
                       java.lang.String sender,
                       java.lang.String message)

Sends the output to the place that was configured. Using the OUTPUT constant, decides how to send the message from the bot. Messages may go to channel, private message, or notice, depending on the OUTPUT constant used. Defaults to sending to the channel.

Parameters:

output - the output method, one of the plugin OUTPUT constants

channel - the name of the channel to send to

sender - the name of the sender to send to

message - the message that will be sent

getVersion

public java.lang.String getVersion()

Gets the version of the plugin. This is used by the core when displaying version information about the plugin.

Returns:

the plugin version

setVersion

protected void setVersion(java.lang.String thisVersion)

Set the version of the plugin. This should be done by the plugin in the Constructor or init() method.

Parameters:

thisVersion - version of the plugin

getPPFResourceBundle

protected PPFResourceBundle getPPFResourceBundle()

A resource bundle that contains all of the available language resource bundles for this plugin.

Returns:

PPFResourceBundle bundle for this plugin

readProperties

protected void readProperties(java.lang.String bundleName)

Read a set of properties files in for use by this plugin.

Parameters:

bundleName - the base name of the properties to read in

getFormattedString

protected java.lang.String getFormattedString(java.lang.String language,
                                              java.lang.String key,
                                              java.lang.String defaultValue,
                                              java.lang.Object[] arguments)

read a language dependent string (with placeholders) from the associated ressource bundle

Parameters:

language - ressource language to be used

key - key for lookup in resouce bundle

defaultValue - value to be used if key is not available in ressource bundle

arguments - arguments to put into the placeholders of the retrieved string

Returns:

fully formatted string with arguments included

getFormattedString

protected java.lang.String getFormattedString(java.lang.String language,
                                              java.lang.String key,
                                              java.lang.String defaultValue)

read a language dependent string (without placeholders) from the ressouce bundle

Parameters:

language - ressource language to be used

key - key for lookup in resouce bundle

defaultValue - value to be used if key is not available in ressource bundle

Returns:

language dependent string

getFormattedString

protected java.lang.String getFormattedString(java.lang.String key,
                                              java.lang.String defaultValue)

read a string from the language ressouce bundle for the default bot language

Parameters:

key - key for lookup in resouce bundle

defaultValue - value to be used if key is not available in ressource bundle

Returns:

language dependent string

getFormattedString

protected java.lang.String getFormattedString(java.lang.String key,
                                              java.lang.String defaultValue,
                                              java.lang.Object[] arguments)

read a string from the language ressouce bundle for the default bot language

Parameters:

key - key for lookup in resouce bundle

defaultValue - value to be used if key is not available in ressource bundle

Returns:

language dependent string

getFormattedStringFor

protected java.lang.String getFormattedStringFor(java.lang.String sender,
                                                 java.lang.String key,
                                                 java.lang.String defaultValue,
                                                 java.lang.Object[] arguments)

read a string from the language ressource bundle for the language of the sender

Parameters:

sender - user for whom the language ressource shall be selected

key - key for lookup in resouce bundle

defaultValue - value to be used if key is not available in ressource bundle

arguments - arguments to put into the placeholders of the retrieved string

Returns:

language dependent string

getFormattedStringFor

protected java.lang.String getFormattedStringFor(java.lang.String sender,
                                                 java.lang.String key,
                                                 java.lang.String defaultValue)

read a string from the language ressource bundle for the language of the sender

Parameters:

sender - user for whom the language ressource shall be selected

key - key for lookup in resouce bundle

defaultValue - value to be used if key is not available in ressource bundle

Returns:

language dependent string

getDoc

protected org.jdom.Document getDoc()

The JDom Document that is created when reading in the XML config.

Returns:

Document the JDom Document representing the XML config.

getUrlStr

protected java.lang.String getUrlStr()

The location of where this plugin is running from in URL from.

Returns:

String url formatted location of where the plugin is running from.

getXMLFilename

protected java.lang.String getXMLFilename()

The filename of the XML config that is used by this plugin.

Returns:

String the XML config filename

loadDoc

protected org.jdom.Document loadDoc(java.lang.String filename)

Loads an XML document. This is generally for loading the plugin config files.

Parameters:

filename - the XML document to load

Returns:

Document a JDOM representation of the XML file read in

saveDoc

protected boolean saveDoc()

Save the currently loaded XML document.

Returns:

true on success, false otherwise (in which case see log for info)

saveDocAs

protected boolean saveDocAs(java.lang.String newFilename)

Save the currently loaded XML document to an alternate file.

Returns:

true on success, false otherwise (in which case see log for info)

getTextFromDoc

protected java.lang.String getTextFromDoc(java.lang.String path)

Get text from an XML element.

Parameters:

path - the path to the element containing the text

Returns:

the content of the element as a String, null if not found

getListFromDoc

protected java.util.List getListFromDoc(java.lang.String path)

Get a list of elements from the Document.

Parameters:

path - the path to the element containing the list

Returns:

a List of the elements under the path, null if not found

getBooleanFromDoc

protected boolean getBooleanFromDoc(java.lang.String path)

Get the boolean value from a text representation. Valid values that will return true are: yes, true, on. All other values will return false.

Parameters:

path - the path to the element containing the text

Returns:

boolean value represented by the text

getAttributeFromDoc

protected java.lang.String getAttributeFromDoc(java.lang.String path,
                                               java.lang.String attribute)

Get an attribute from an element in the document.

Parameters:

path - the path to the element containing the attribute

attribute - the attribute to get the text from

Returns:

the content of theattribute, null if not found

setHelp

protected void setHelp(java.lang.String command,
                       PPFHelp ppfHelp)

Adds online help information for a command in the plugin.

Parameters:

command - the command to associate the help with

ppfHelp - the help text for the command

getHelp

protected java.util.HashMap<java.lang.String,PPFHelp> getHelp()

Gets all of the help for this plugin.

Returns:

the help available for this plugin, the key is the command

getItemList

protected java.util.HashMap<java.lang.String,java.lang.String> getItemList()

Easy way to keep hold of a list of String items.

Returns:

HashMap helper list that can be operated on easily with the XML config

getFromItemList

protected java.lang.String getFromItemList(java.lang.String key)

Select a single item from the list by using the key.

Parameters:

key - to search for

Returns:

the value, null if not in list

isInItemList

protected boolean isInItemList(java.lang.String key)

Check if an item is in the list, by key.

Parameters:

key - to check for

Returns:

true if the key is in the list

addToItemList

protected boolean addToItemList(java.lang.String key,
                                java.lang.String value)

Adds a new item to the list in memory.

Parameters:

key - to use for adding the item

value - item to add to the list

Returns:

true if the item was added, false if it already existed on the list

addToItemList

protected boolean addToItemList(java.lang.String listElem,
                                org.jdom.Element newElement,
                                java.lang.String key,
                                java.lang.String value)

Adds a new item to the persitent list.

Parameters:

listElem - name of the list element

newElement - new element to add

key - to use for adding the item

value - item to add to the list

Returns:

true if the item was added, false if any problem occured while adding the item

removeFromItemList

protected boolean removeFromItemList(java.lang.String childElem,
                                     java.lang.String xPath,
                                     java.lang.String key)

Remove an item from the persitent list.

Parameters:

childElem - name of the list element

xPath - path to the element

key - key of the item to be removed

Returns:

true if the item was removed, false if any problem occured while removing the item

viewItemList

protected void viewItemList(java.lang.String sender)

View all items in the list. This uses DCC chat due to the possible volume of the list. The default DCC chat timeout is used.

Parameters:

sender - the person to create a DCC chat session with

viewItemList

protected void viewItemList(java.lang.String sender,
                            int timeout)

View all items in the list. This uses DCC chat due to the possible volume of the list.

Parameters:

sender - the person to create a DCC chat session with

timeout - how long to wait for an answer before giving up

authLevelFromString

protected int authLevelFromString(java.lang.String authLevel)

Figure out what the required auth level is. With some commands, you can configure who is allowed to run them. This takes the configured text and returns an auth level that PPF understands.

Parameters:

authLevel - string representation of the auth level

Returns:

PPF auth level from the string representation, defaults to PPF.AUTH_NONE if a value that is not recognised if given

onAuth

protected void onAuth(java.lang.String login,
                      java.lang.String channel)

Send info that login has AUTHed with the system and the channel they are in. This method is called repeatedly from PPF when someone is authed with each channel they are in. Information, such as, what auth level can be found from the isAuth(login, authLevel) method in PPF.

Parameters:

login - the login that just AUTHed

channel - the channel that

onAction

protected void onAction(java.lang.String sender,
                        java.lang.String login,
                        java.lang.String hostname,
                        java.lang.String target,
                        java.lang.String action)

JavaDocs for this method are from: PircBot onAction

onChannelInfo

protected void onChannelInfo(java.lang.String channel,
                             int userCount,
                             java.lang.String topic)

JavaDocs for this method are from: PircBot onChannelInfo

onConnect

protected void onConnect()

JavaDocs for this method are from: PircBot onConnect

onDeop

protected void onDeop(java.lang.String channel,
                      java.lang.String sourceNick,
                      java.lang.String sourceLogin,
                      java.lang.String sourceHostname,
                      java.lang.String recipient)

JavaDocs for this method are from: PircBot onDeop

onDeVoice

protected void onDeVoice(java.lang.String channel,
                         java.lang.String sourceNick,
                         java.lang.String sourceLogin,
                         java.lang.String sourceHostname,
                         java.lang.String recipient)

JavaDocs for this method are from: PircBot onDeVoice

onDisconnect

protected void onDisconnect()

JavaDocs for this method are from: PircBot onDisconnect

onFileTransferFinished

protected void onFileTransferFinished(org.jibble.pircbot.DccFileTransfer transfer,
                                      java.lang.Exception e)

JavaDocs for this method are from: PircBot onFileTransferFinished

onFinger

protected void onFinger(java.lang.String sourceNick,
                        java.lang.String sourceLogin,
                        java.lang.String sourceHostname,
                        java.lang.String target)

JavaDocs for this method are from: PircBot onFinger

onIncomingChatRequest

protected void onIncomingChatRequest(org.jibble.pircbot.DccChat chat)

JavaDocs for this method are from: PircBot onIncomingChatRequest

onIncomingFileTransfer

protected void onIncomingFileTransfer(org.jibble.pircbot.DccFileTransfer transfer)

JavaDocs for this method are from: PircBot onIncomingFileTransfer

onInvite

protected void onInvite(java.lang.String targetNick,
                        java.lang.String sourceNick,
                        java.lang.String sourceLogin,
                        java.lang.String sourceHostname,
                        java.lang.String channel)

JavaDocs for this method are from: PircBot onInvite

onJoin

protected void onJoin(java.lang.String channel,
                      java.lang.String sender,
                      java.lang.String login,
                      java.lang.String hostname)

JavaDocs for this method are from: PircBot onJoin

onKick

protected void onKick(java.lang.String channel,
                      java.lang.String kickerNick,
                      java.lang.String kickerLogin,
                      java.lang.String kickerHostname,
                      java.lang.String recipientNick,
                      java.lang.String reason)

JavaDocs for this method are from: PircBot onKick

onMessage

protected void onMessage(java.lang.String channel,
                         java.lang.String sender,
                         java.lang.String login,
                         java.lang.String hostname,
                         java.lang.String message)

JavaDocs for this method are from: PircBot onMessage

onMode

protected void onMode(java.lang.String channel,
                      java.lang.String sourceNick,
                      java.lang.String sourceLogin,
                      java.lang.String sourceHostname,
                      java.lang.String mode)

JavaDocs for this method are from: PircBot onMode

onNickChange

protected void onNickChange(java.lang.String oldNick,
                            java.lang.String login,
                            java.lang.String hostname,
                            java.lang.String newNick)

JavaDocs for this method are from: PircBot onNickChange

onNotice

protected void onNotice(java.lang.String sourceNick,
                        java.lang.String sourceLogin,
                        java.lang.String sourceHostname,
                        java.lang.String target,
                        java.lang.String notice)

JavaDocs for this method are from: PircBot onNotice

onOp

protected void onOp(java.lang.String channel,
                    java.lang.String sourceNick,
                    java.lang.String sourceLogin,
                    java.lang.String sourceHostname,
                    java.lang.String recipient)

JavaDocs for this method are from: PircBot onOp

onPart

protected void onPart(java.lang.String channel,
                      java.lang.String sender,
                      java.lang.String login,
                      java.lang.String hostname)

JavaDocs for this method are from: PircBot onPart

onPing

protected void onPing(java.lang.String sourceNick,
                      java.lang.String sourceLogin,
                      java.lang.String sourceHostname,
                      java.lang.String target,
                      java.lang.String pingValue)

JavaDocs for this method are from: PircBot onPing

onPrivateMessage

protected void onPrivateMessage(java.lang.String sender,
                                java.lang.String login,
                                java.lang.String hostname,
                                java.lang.String message)

JavaDocs for this method are from: PircBot onPrivateMessage

onQuit

protected void onQuit(java.lang.String sourceNick,
                      java.lang.String sourceLogin,
                      java.lang.String sourceHostname,
                      java.lang.String reason)

JavaDocs for this method are from: PircBot onQuit

onRemoveChannelBan

protected void onRemoveChannelBan(java.lang.String channel,
                                  java.lang.String sourceNick,
                                  java.lang.String sourceLogin,
                                  java.lang.String sourceHostname,
                                  java.lang.String hostmask)

JavaDocs for this method are from: PircBot onRemoveChannelBan

onRemoveChannelKey

protected void onRemoveChannelKey(java.lang.String channel,
                                  java.lang.String sourceNick,
                                  java.lang.String sourceLogin,
                                  java.lang.String sourceHostname,
                                  java.lang.String key)

JavaDocs for this method are from: PircBot onRemoveChannelKey

onRemoveChannelLimit

protected void onRemoveChannelLimit(java.lang.String channel,
                                    java.lang.String sourceNick,
                                    java.lang.String sourceLogin,
                                    java.lang.String sourceHostname)

JavaDocs for this method are from: PircBot onRemoveChannelLimit

onRemoveInviteOnly

protected void onRemoveInviteOnly(java.lang.String channel,
                                  java.lang.String sourceNick,
                                  java.lang.String sourceLogin,
                                  java.lang.String sourceHostname)

JavaDocs for this method are from: PircBot onRemoveInviteOnly

onRemoveModerated

protected void onRemoveModerated(java.lang.String channel,
                                 java.lang.String sourceNick,
                                 java.lang.String sourceLogin,
                                 java.lang.String sourceHostname)

JavaDocs for this method are from: PircBot onRemoveModerated

onRemoveNoExternalMessages

protected void onRemoveNoExternalMessages(java.lang.String channel,
                                          java.lang.String sourceNick,
                                          java.lang.String sourceLogin,
                                          java.lang.String sourceHostname)

JavaDocs for this method are from: PircBot onRemoveNoExternalMessages

onRemovePrivate

protected void onRemovePrivate(java.lang.String channel,
                               java.lang.String sourceNick,
                               java.lang.String sourceLogin,
                               java.lang.String sourceHostname)

JavaDocs for this method are from: PircBot onRemovePrivate

onRemoveSecret

protected void onRemoveSecret(java.lang.String channel,
                              java.lang.String sourceNick,
                              java.lang.String sourceLogin,
                              java.lang.String sourceHostname)

JavaDocs for this method are from: PircBot onRemoveSecret

onRemoveTopicProtection

protected void onRemoveTopicProtection(java.lang.String channel,
                                       java.lang.String sourceNick,
                                       java.lang.String sourceLogin,
                                       java.lang.String sourceHostname)

JavaDocs for this method are from: PircBot onRemoveTopicProtection

onServerPing

protected void onServerPing(java.lang.String response)

JavaDocs for this method are from: PircBot onServerPing

onServerResponse

protected void onServerResponse(int code,
                                java.lang.String response)

JavaDocs for this method are from: PircBot onServerResponse

onSetChannelBan

protected void onSetChannelBan(java.lang.String channel,
                               java.lang.String sourceNick,
                               java.lang.String sourceLogin,
                               java.lang.String sourceHostname,
                               java.lang.String hostmask)

JavaDocs for this method are from: PircBot onSetChannelBan

onSetChannelKey

protected void onSetChannelKey(java.lang.String channel,
                               java.lang.String sourceNick,
                               java.lang.String sourceLogin,
                               java.lang.String sourceHostname,
                               java.lang.String key)

JavaDocs for this method are from: PircBot onSetChannelKey

onSetChannelLimit

protected void onSetChannelLimit(java.lang.String channel,
                                 java.lang.String sourceNick,
                                 java.lang.String sourceLogin,
                                 java.lang.String sourceHostname,
                                 int limit)

JavaDocs for this method are from: PircBot onSetChannelLimit

onSetInviteOnly

protected void onSetInviteOnly(java.lang.String channel,
                               java.lang.String sourceNick,
                               java.lang.String sourceLogin,
                               java.lang.String sourceHostname)

JavaDocs for this method are from: PircBot onSetInviteOnly

onSetModerated

protected void onSetModerated(java.lang.String channel,
                              java.lang.String sourceNick,
                              java.lang.String sourceLogin,
                              java.lang.String sourceHostname)

JavaDocs for this method are from: PircBot onSetModerated

onSetNoExternalMessages

protected void onSetNoExternalMessages(java.lang.String channel,
                                       java.lang.String sourceNick,
                                       java.lang.String sourceLogin,
                                       java.lang.String sourceHostname)

JavaDocs for this method are from: PircBot onSetNoExternalMessages

onSetPrivate

protected void onSetPrivate(java.lang.String channel,
                            java.lang.String sourceNick,
                            java.lang.String sourceLogin,
                            java.lang.String sourceHostname)

JavaDocs for this method are from: PircBot onSetPrivate

onSetSecret

protected void onSetSecret(java.lang.String channel,
                           java.lang.String sourceNick,
                           java.lang.String sourceLogin,
                           java.lang.String sourceHostname)

JavaDocs for this method are from: PircBot onSetSecret

onSetTopicProtection

protected void onSetTopicProtection(java.lang.String channel,
                                    java.lang.String sourceNick,
                                    java.lang.String sourceLogin,
                                    java.lang.String sourceHostname)

JavaDocs for this method are from: PircBot onSetTopicProtection

onTime

protected void onTime(java.lang.String sourceNick,
                      java.lang.String sourceLogin,
                      java.lang.String sourceHostname,
                      java.lang.String target)

JavaDocs for this method are from: PircBot onTime

onTopic

protected void onTopic(java.lang.String channel,
                       java.lang.String topic,
                       java.lang.String setBy,
                       long date,
                       boolean changed)

JavaDocs for this method are from: PircBot onTopic

onUnknown

protected void onUnknown(java.lang.String line)

JavaDocs for this method are from: PircBot onUnknown

onUserList

protected void onUserList(java.lang.String channel,
                          org.jibble.pircbot.User[] users)

JavaDocs for this method are from: PircBot onUserList

onUserMode

protected void onUserMode(java.lang.String targetNick,
                          java.lang.String sourceNick,
                          java.lang.String sourceLogin,
                          java.lang.String sourceHostname,
                          java.lang.String mode)

JavaDocs for this method are from: PircBot onUserMode

onVersion

protected void onVersion(java.lang.String sourceNick,
                         java.lang.String sourceLogin,
                         java.lang.String sourceHostname,
                         java.lang.String target)

JavaDocs for this method are from: PircBot onVersion

onVoice

protected void onVoice(java.lang.String channel,
                       java.lang.String sourceNick,
                       java.lang.String sourceLogin,
                       java.lang.String sourceHostname,
                       java.lang.String recipient)

JavaDocs for this method are from: PircBot onVoice