|
@@ -0,0 +1,218 @@
|
|
|
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
|
+<!--NewPage-->
|
|
|
+<HTML>
|
|
|
+<HEAD>
|
|
|
+<!-- Generated by javadoc (build 1.4.2) on Mon Dec 14 20:07:23 GMT 2009 -->
|
|
|
+<TITLE>
|
|
|
+org.jibble.pircbot (PircBot 1.5.0 - Java IRC API Bot Framework)
|
|
|
+</TITLE>
|
|
|
+
|
|
|
+<META NAME="keywords" CONTENT="org.jibble.pircbot package">
|
|
|
+
|
|
|
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../pircbot-style.css" TITLE="Style">
|
|
|
+
|
|
|
+<SCRIPT type="text/javascript">
|
|
|
+function windowTitle()
|
|
|
+{
|
|
|
+ parent.document.title="org.jibble.pircbot (PircBot 1.5.0 - Java IRC API Bot Framework)";
|
|
|
+}
|
|
|
+</SCRIPT>
|
|
|
+
|
|
|
+</HEAD>
|
|
|
+
|
|
|
+<BODY BGCOLOR="white" onload="windowTitle();">
|
|
|
+
|
|
|
+
|
|
|
+<!-- ========= START OF TOP NAVBAR ======= -->
|
|
|
+<A NAME="navbar_top"><!-- --></A>
|
|
|
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
|
|
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
|
+<TR>
|
|
|
+<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
|
+<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
|
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
|
+ <TR ALIGN="center" VALIGN="top">
|
|
|
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
|
|
|
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
|
|
|
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
|
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
|
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
|
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
|
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
|
+ </TR>
|
|
|
+</TABLE>
|
|
|
+</TD>
|
|
|
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
|
+<b>PircBot Java IRC Bot</b></EM>
|
|
|
+</TD>
|
|
|
+</TR>
|
|
|
+
|
|
|
+<TR>
|
|
|
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
+ PREV PACKAGE
|
|
|
+ NEXT PACKAGE</FONT></TD>
|
|
|
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
+ <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
|
|
|
+ <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
|
|
|
+ <SCRIPT type="text/javascript">
|
|
|
+ <!--
|
|
|
+ if(window==top) {
|
|
|
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
|
+ }
|
|
|
+ //-->
|
|
|
+</SCRIPT>
|
|
|
+<NOSCRIPT>
|
|
|
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
|
+</NOSCRIPT>
|
|
|
+
|
|
|
+</FONT></TD>
|
|
|
+</TR>
|
|
|
+</TABLE>
|
|
|
+<A NAME="skip-navbar_top"></A>
|
|
|
+<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
+
|
|
|
+<HR>
|
|
|
+<H2>
|
|
|
+Package org.jibble.pircbot
|
|
|
+</H2>
|
|
|
+
|
|
|
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
+<TD COLSPAN=2><FONT SIZE="+2">
|
|
|
+<B>Interface Summary</B></FONT></TD>
|
|
|
+</TR>
|
|
|
+<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
+<TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/ReplyConstants.html" title="interface in org.jibble.pircbot">ReplyConstants</A></B></TD>
|
|
|
+<TD>This interface contains the values of all numeric replies specified
|
|
|
+ in section 6 of RFC 1459.</TD>
|
|
|
+</TR>
|
|
|
+</TABLE>
|
|
|
+
|
|
|
+
|
|
|
+<P>
|
|
|
+
|
|
|
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
+<TD COLSPAN=2><FONT SIZE="+2">
|
|
|
+<B>Class Summary</B></FONT></TD>
|
|
|
+</TR>
|
|
|
+<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
+<TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/Colors.html" title="class in org.jibble.pircbot">Colors</A></B></TD>
|
|
|
+<TD>The Colors class provides several static fields and methods that you may
|
|
|
+ find useful when writing an IRC Bot.</TD>
|
|
|
+</TR>
|
|
|
+<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
+<TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/DccChat.html" title="class in org.jibble.pircbot">DccChat</A></B></TD>
|
|
|
+<TD>This class is used to allow the bot to interact with a DCC Chat session.</TD>
|
|
|
+</TR>
|
|
|
+<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
+<TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/DccFileTransfer.html" title="class in org.jibble.pircbot">DccFileTransfer</A></B></TD>
|
|
|
+<TD>This class is used to administer a DCC file transfer.</TD>
|
|
|
+</TR>
|
|
|
+<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
+<TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/DccManager.html" title="class in org.jibble.pircbot">DccManager</A></B></TD>
|
|
|
+<TD>This class is used to process DCC events from the server.</TD>
|
|
|
+</TR>
|
|
|
+<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
+<TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/IdentServer.html" title="class in org.jibble.pircbot">IdentServer</A></B></TD>
|
|
|
+<TD>A simple IdentServer (also know as "The Identification Protocol").</TD>
|
|
|
+</TR>
|
|
|
+<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
+<TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/InputThread.html" title="class in org.jibble.pircbot">InputThread</A></B></TD>
|
|
|
+<TD>A Thread which reads lines from the IRC server.</TD>
|
|
|
+</TR>
|
|
|
+<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
+<TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/OutputThread.html" title="class in org.jibble.pircbot">OutputThread</A></B></TD>
|
|
|
+<TD>A Thread which is responsible for sending messages to the IRC server.</TD>
|
|
|
+</TR>
|
|
|
+<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
+<TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/PircBot.html" title="class in org.jibble.pircbot">PircBot</A></B></TD>
|
|
|
+<TD>PircBot is a Java framework for writing IRC bots quickly and easily.</TD>
|
|
|
+</TR>
|
|
|
+<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
+<TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/Queue.html" title="class in org.jibble.pircbot">Queue</A></B></TD>
|
|
|
+<TD>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.</TD>
|
|
|
+</TR>
|
|
|
+<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
+<TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/User.html" title="class in org.jibble.pircbot">User</A></B></TD>
|
|
|
+<TD>This class is used to represent a user on an IRC server.</TD>
|
|
|
+</TR>
|
|
|
+</TABLE>
|
|
|
+
|
|
|
+
|
|
|
+<P>
|
|
|
+
|
|
|
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
+<TD COLSPAN=2><FONT SIZE="+2">
|
|
|
+<B>Exception Summary</B></FONT></TD>
|
|
|
+</TR>
|
|
|
+<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
+<TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/IrcException.html" title="class in org.jibble.pircbot">IrcException</A></B></TD>
|
|
|
+<TD>An IrcException class.</TD>
|
|
|
+</TR>
|
|
|
+<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
+<TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/NickAlreadyInUseException.html" title="class in org.jibble.pircbot">NickAlreadyInUseException</A></B></TD>
|
|
|
+<TD>A NickAlreadyInUseException class.</TD>
|
|
|
+</TR>
|
|
|
+</TABLE>
|
|
|
+
|
|
|
+
|
|
|
+<P>
|
|
|
+<HR>
|
|
|
+
|
|
|
+
|
|
|
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
|
+<A NAME="navbar_bottom"><!-- --></A>
|
|
|
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
|
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
|
+<TR>
|
|
|
+<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
|
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
|
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
|
+ <TR ALIGN="center" VALIGN="top">
|
|
|
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
|
|
|
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
|
|
|
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
|
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
|
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
|
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
|
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
|
+ </TR>
|
|
|
+</TABLE>
|
|
|
+</TD>
|
|
|
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
|
+<b>PircBot Java IRC Bot</b></EM>
|
|
|
+</TD>
|
|
|
+</TR>
|
|
|
+
|
|
|
+<TR>
|
|
|
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
+ PREV PACKAGE
|
|
|
+ NEXT PACKAGE</FONT></TD>
|
|
|
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
+ <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
|
|
|
+ <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
|
|
|
+ <SCRIPT type="text/javascript">
|
|
|
+ <!--
|
|
|
+ if(window==top) {
|
|
|
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
|
+ }
|
|
|
+ //-->
|
|
|
+</SCRIPT>
|
|
|
+<NOSCRIPT>
|
|
|
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
|
+</NOSCRIPT>
|
|
|
+
|
|
|
+</FONT></TD>
|
|
|
+</TR>
|
|
|
+</TABLE>
|
|
|
+<A NAME="skip-navbar_bottom"></A>
|
|
|
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
+
|
|
|
+<HR>
|
|
|
+
|
|
|
+</BODY>
|
|
|
+</HTML>
|