Class ApiPlugin

java.lang.Object
  ApiPlugin

All Implemented Interfaces:

Plugin

public class ApiPlugin
extends java.lang.Object
implements Plugin

Supplies commands to access the functionality implemented by RequestHandler. This will allow users to access the api search functions.

Commands available

api		search all information available (methods and classes) for the given term
class		search classes only for the given term
method		search methods only for the given term
apistat		return short information about the last search (execution time)
apireload	*	causes the api to be reload

* restricted

Author:

honk

Constructor Summary

ApiPlugin()

Method Summary

java.lang.String[]	getCommands() A list of commands that this plugins want to handle.
java.lang.String[]	getRestrictedCommands() A list of restricted commands that this plugins want to handle.
void	handleEvent(IrcCommandEvent ice) This method will be called whenever an event this plugin can handle occurs.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiPlugin

public ApiPlugin()

Method Detail

getCommands

public java.lang.String[] getCommands()

Description copied from interface: Plugin

A list of commands that this plugins want to handle. Each command has to be plain text without any prefixes.

Specified by:

getCommands in interface Plugin

Returns:

a list of commands handled by this plugin

getRestrictedCommands

public java.lang.String[] getRestrictedCommands()

Description copied from interface: Plugin

A list of restricted commands that this plugins want to handle. Each command has to be plain text without any prefixes. The access will only be allowed if the user has access to the admin functions.

Specified by:

getRestrictedCommands in interface Plugin

Returns:

a list of restricted commands handled by this plugin

handleEvent

public void handleEvent(IrcCommandEvent ice)

Description copied from interface: Plugin

This method will be called whenever an event this plugin can handle occurs. The IrcCommandEvent will hold the information necessary to find out which command was called.

Specified by:

handleEvent in interface Plugin

Parameters:

ice - the Event that occured