Package leafchat.core.api

leafChat's core API, available to all plugins.

See:
          Description

Interface Summary
Factory Implement this in factory classes
FactoryObject Does nothing: only marks an interface as creatable using the FactoryManager API.
MessageDispatch Provided by the system to MessageOwner classes.
MessageFilter Interface representing the most basic version of a message filter.
MsgOwner Implemented by classes that dispatch messages.
Plugin Interface that must be implemented by all Plugin main classes
PluginContext Interface that a plugin can use to request system services.
PluginExport Information about an exported API package
PluginInfo Information about a particular plugin
PluginList Provides a list of all plugins for information and can save a jar file that includes selected plugins for use by plugin developers.
PluginLoadReporter Called to pass back information about progress of plugin load
Singleton Interface does nothing: just marks an interface as available via Singleton access.
SystemLog Use to log data that may be of interest in debugging or troubleshooting.
 

Class Summary
BasicMsgOwner Utility class that implements most of MsgOwner (assuming you are going to let the system handle target registration).
ErrorMsg Sent when an error has occurred and should be reported to the user.
FilterInfo Metadata about a particular message filter type.
FilterInfo.Parameter Stores information about a parameter to the filter constructor.
MessageInfo Provides information about a particular class of Msg.
MinuteFilter Used to receive the per-minute messages less often
MinuteMsg Message sent every minute
Msg Generic object representing communication between plugins.
PluginUnloadMsg Message sent when a plugin is being unloaded.
SystemStateMsg Message sent when leafChat has loaded all plugins and is ready to start up
SystemVersion Access to leafChat core version numbers
 

Exception Summary
BugException Exception probably indicates a bug in a plugin or the system.
GeneralException General exceptions (this is often used to wrap other exceptions so that handling is easier, but we know they've been considered)
 

Package leafchat.core.api Description

leafChat's core API, available to all plugins. Includes the message system, singletons, plugin management, and exception types.



Copyright © 2011 Samuel Marshall. All rights reserved.