package-summary.html 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc (build 1.4.2) on Mon Dec 14 20:07:23 GMT 2009 -->
  6. <TITLE>
  7. org.jibble.pircbot (PircBot 1.5.0 - Java IRC API Bot Framework)
  8. </TITLE>
  9. <META NAME="keywords" CONTENT="org.jibble.pircbot package">
  10. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../pircbot-style.css" TITLE="Style">
  11. <SCRIPT type="text/javascript">
  12. function windowTitle()
  13. {
  14. parent.document.title="org.jibble.pircbot (PircBot 1.5.0 - Java IRC API Bot Framework)";
  15. }
  16. </SCRIPT>
  17. </HEAD>
  18. <BODY BGCOLOR="white" onload="windowTitle();">
  19. <!-- ========= START OF TOP NAVBAR ======= -->
  20. <A NAME="navbar_top"><!-- --></A>
  21. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  22. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  23. <TR>
  24. <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  25. <A NAME="navbar_top_firstrow"><!-- --></A>
  26. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  27. <TR ALIGN="center" VALIGN="top">
  28. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
  29. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  30. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  31. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  32. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  33. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  34. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  35. </TR>
  36. </TABLE>
  37. </TD>
  38. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  39. <b>PircBot Java IRC Bot</b></EM>
  40. </TD>
  41. </TR>
  42. <TR>
  43. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  44. &nbsp;PREV PACKAGE&nbsp;
  45. &nbsp;NEXT PACKAGE</FONT></TD>
  46. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  47. <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
  48. &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  49. &nbsp;<SCRIPT type="text/javascript">
  50. <!--
  51. if(window==top) {
  52. document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  53. }
  54. //-->
  55. </SCRIPT>
  56. <NOSCRIPT>
  57. <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  58. </NOSCRIPT>
  59. </FONT></TD>
  60. </TR>
  61. </TABLE>
  62. <A NAME="skip-navbar_top"></A>
  63. <!-- ========= END OF TOP NAVBAR ========= -->
  64. <HR>
  65. <H2>
  66. Package org.jibble.pircbot
  67. </H2>
  68. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  69. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  70. <TD COLSPAN=2><FONT SIZE="+2">
  71. <B>Interface Summary</B></FONT></TD>
  72. </TR>
  73. <TR BGCOLOR="white" CLASS="TableRowColor">
  74. <TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/ReplyConstants.html" title="interface in org.jibble.pircbot">ReplyConstants</A></B></TD>
  75. <TD>This interface contains the values of all numeric replies specified
  76. in section 6 of RFC 1459.</TD>
  77. </TR>
  78. </TABLE>
  79. &nbsp;
  80. <P>
  81. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  82. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  83. <TD COLSPAN=2><FONT SIZE="+2">
  84. <B>Class Summary</B></FONT></TD>
  85. </TR>
  86. <TR BGCOLOR="white" CLASS="TableRowColor">
  87. <TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/Colors.html" title="class in org.jibble.pircbot">Colors</A></B></TD>
  88. <TD>The Colors class provides several static fields and methods that you may
  89. find useful when writing an IRC Bot.</TD>
  90. </TR>
  91. <TR BGCOLOR="white" CLASS="TableRowColor">
  92. <TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/DccChat.html" title="class in org.jibble.pircbot">DccChat</A></B></TD>
  93. <TD>This class is used to allow the bot to interact with a DCC Chat session.</TD>
  94. </TR>
  95. <TR BGCOLOR="white" CLASS="TableRowColor">
  96. <TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/DccFileTransfer.html" title="class in org.jibble.pircbot">DccFileTransfer</A></B></TD>
  97. <TD>This class is used to administer a DCC file transfer.</TD>
  98. </TR>
  99. <TR BGCOLOR="white" CLASS="TableRowColor">
  100. <TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/DccManager.html" title="class in org.jibble.pircbot">DccManager</A></B></TD>
  101. <TD>This class is used to process DCC events from the server.</TD>
  102. </TR>
  103. <TR BGCOLOR="white" CLASS="TableRowColor">
  104. <TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/IdentServer.html" title="class in org.jibble.pircbot">IdentServer</A></B></TD>
  105. <TD>A simple IdentServer (also know as "The Identification Protocol").</TD>
  106. </TR>
  107. <TR BGCOLOR="white" CLASS="TableRowColor">
  108. <TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/InputThread.html" title="class in org.jibble.pircbot">InputThread</A></B></TD>
  109. <TD>A Thread which reads lines from the IRC server.</TD>
  110. </TR>
  111. <TR BGCOLOR="white" CLASS="TableRowColor">
  112. <TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/OutputThread.html" title="class in org.jibble.pircbot">OutputThread</A></B></TD>
  113. <TD>A Thread which is responsible for sending messages to the IRC server.</TD>
  114. </TR>
  115. <TR BGCOLOR="white" CLASS="TableRowColor">
  116. <TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/PircBot.html" title="class in org.jibble.pircbot">PircBot</A></B></TD>
  117. <TD>PircBot is a Java framework for writing IRC bots quickly and easily.</TD>
  118. </TR>
  119. <TR BGCOLOR="white" CLASS="TableRowColor">
  120. <TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/Queue.html" title="class in org.jibble.pircbot">Queue</A></B></TD>
  121. <TD>Queue is a definition of a data structure that may
  122. act as a queue - that is, data can be added to one end of the
  123. queue and data can be requested from the head end of the queue.</TD>
  124. </TR>
  125. <TR BGCOLOR="white" CLASS="TableRowColor">
  126. <TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/User.html" title="class in org.jibble.pircbot">User</A></B></TD>
  127. <TD>This class is used to represent a user on an IRC server.</TD>
  128. </TR>
  129. </TABLE>
  130. &nbsp;
  131. <P>
  132. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  133. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  134. <TD COLSPAN=2><FONT SIZE="+2">
  135. <B>Exception Summary</B></FONT></TD>
  136. </TR>
  137. <TR BGCOLOR="white" CLASS="TableRowColor">
  138. <TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/IrcException.html" title="class in org.jibble.pircbot">IrcException</A></B></TD>
  139. <TD>An IrcException class.</TD>
  140. </TR>
  141. <TR BGCOLOR="white" CLASS="TableRowColor">
  142. <TD WIDTH="15%"><B><A HREF="../../../org/jibble/pircbot/NickAlreadyInUseException.html" title="class in org.jibble.pircbot">NickAlreadyInUseException</A></B></TD>
  143. <TD>A NickAlreadyInUseException class.</TD>
  144. </TR>
  145. </TABLE>
  146. &nbsp;
  147. <P>
  148. <HR>
  149. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  150. <A NAME="navbar_bottom"><!-- --></A>
  151. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  152. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  153. <TR>
  154. <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  155. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  156. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  157. <TR ALIGN="center" VALIGN="top">
  158. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
  159. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  160. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  161. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  162. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  163. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  164. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  165. </TR>
  166. </TABLE>
  167. </TD>
  168. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  169. <b>PircBot Java IRC Bot</b></EM>
  170. </TD>
  171. </TR>
  172. <TR>
  173. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  174. &nbsp;PREV PACKAGE&nbsp;
  175. &nbsp;NEXT PACKAGE</FONT></TD>
  176. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  177. <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
  178. &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  179. &nbsp;<SCRIPT type="text/javascript">
  180. <!--
  181. if(window==top) {
  182. document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  183. }
  184. //-->
  185. </SCRIPT>
  186. <NOSCRIPT>
  187. <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  188. </NOSCRIPT>
  189. </FONT></TD>
  190. </TR>
  191. </TABLE>
  192. <A NAME="skip-navbar_bottom"></A>
  193. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  194. <HR>
  195. </BODY>
  196. </HTML>