123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <HTML>
- <HEAD>
- <TITLE>
- User (PircBot 1.5.0 - Java IRC API Bot Framework)
- </TITLE>
- <META NAME="keywords" CONTENT="org.jibble.pircbot.User class">
- <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../pircbot-style.css" TITLE="Style">
- <SCRIPT type="text/javascript">
- function windowTitle()
- {
- parent.document.title="User (PircBot 1.5.0 - Java IRC API Bot Framework)";
- }
- </SCRIPT>
- </HEAD>
- <BODY BGCOLOR="white" onload="windowTitle();">
- <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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/User.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">
- <A HREF="../../../org/jibble/pircbot/Queue.html" title="class in org.jibble.pircbot"><B>PREV CLASS</B></A>
- NEXT CLASS</FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
- <A HREF="User.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
-
- </SCRIPT>
- <NOSCRIPT>
- <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_top"></A>
- <HR>
- <H2>
- <FONT SIZE="-1">
- org.jibble.pircbot</FONT>
- <BR>
- Class User</H2>
- <PRE>
- <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
- <IMG SRC="../../../resources/inherit.gif" ALT="extended by"><B>org.jibble.pircbot.User</B>
- </PRE>
- <HR>
- <DL>
- <DT>public class <B>User</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL>
- <P>
- This class is used to represent a user on an IRC server.
- Instances of this class are returned by the getUsers method
- in the PircBot class.
- <p>
- Note that this class no longer implements the Comparable interface
- for Java 1.1 compatibility reasons.
- <P>
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>1.0.0</DD>
- <DT><B>Version:</B></DT>
- <DD>1.5.0 (Build time: Mon Dec 14 20:07:17 2009)</DD>
- <DT><B>Author:</B></DT>
- <DD>Paul James Mutton,
- <a href="http://www.jibble.org/">http://www.jibble.org/</a></DD>
- </DL>
- <HR>
- <P>
- <A NAME="method_summary"></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TD COLSPAN=2><FONT SIZE="+2">
- <B>Method Summary</B></FONT></TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/User.html#compareTo(java.lang.Object)">compareTo</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> o)</CODE>
- <BR>
- Returns the result of calling the compareTo method on lowercased
- nicks.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/User.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> o)</CODE>
- <BR>
- Returns true if the nick represented by this User object is the same
- as the nick of the User object given as an argument.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/User.html#equals(java.lang.String)">equals</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> nick)</CODE>
- <BR>
- Returns true if the nick represented by this User object is the same
- as the argument.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/User.html#getNick()">getNick</A></B>()</CODE>
- <BR>
- Returns the nick of the user.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/User.html#getPrefix()">getPrefix</A></B>()</CODE>
- <BR>
- Returns the prefix of the user.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/User.html#hashCode()">hashCode</A></B>()</CODE>
- <BR>
- Returns the hash code of this User object.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/User.html#hasVoice()">hasVoice</A></B>()</CODE>
- <BR>
- Returns whether or not the user represented by this object has
- voice.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/User.html#isOp()">isOp</A></B>()</CODE>
- <BR>
- Returns whether or not the user represented by this object is an
- operator.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../org/jibble/pircbot/User.html#toString()">toString</A></B>()</CODE>
- <BR>
- Returns the nick of the user complete with their prefix if they
- have one, e.g.</TD>
- </TR>
- </TABLE>
- <A NAME="methods_inherited_from_class_java.lang.Object"></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
- <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
- </TR>
- </TABLE>
-
- <P>
- <A NAME="method_detail"></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TD COLSPAN=1><FONT SIZE="+2">
- <B>Method Detail</B></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="getPrefix()"></A><H3>
- getPrefix</H3>
- <PRE>
- public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getPrefix</B>()</PRE>
- <DL>
- <DD>Returns the prefix of the user. If the User object has been obtained
- from a list of users in a channel, then this will reflect the user's
- status in that channel.
- <P>
- <DD><DL>
- <DT><B>Returns:</B><DD>The prefix of the user. If there is no prefix, then an empty
- String is returned.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="isOp()"></A><H3>
- isOp</H3>
- <PRE>
- public boolean <B>isOp</B>()</PRE>
- <DL>
- <DD>Returns whether or not the user represented by this object is an
- operator. If the User object has been obtained from a list of users
- in a channel, then this will reflect the user's operator status in
- that channel.
- <P>
- <DD><DL>
- <DT><B>Returns:</B><DD>true if the user is an operator in the channel.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="hasVoice()"></A><H3>
- hasVoice</H3>
- <PRE>
- public boolean <B>hasVoice</B>()</PRE>
- <DL>
- <DD>Returns whether or not the user represented by this object has
- voice. If the User object has been obtained from a list of users
- in a channel, then this will reflect the user's voice status in
- that channel.
- <P>
- <DD><DL>
- <DT><B>Returns:</B><DD>true if the user has voice in the channel.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getNick()"></A><H3>
- getNick</H3>
- <PRE>
- public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getNick</B>()</PRE>
- <DL>
- <DD>Returns the nick of the user.
- <P>
- <DD><DL>
- <DT><B>Returns:</B><DD>The user's nick.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="toString()"></A><H3>
- toString</H3>
- <PRE>
- public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
- <DL>
- <DD>Returns the nick of the user complete with their prefix if they
- have one, e.g. "@Dave".
- <P>
- <DD><DL>
- <DT><B>Returns:</B><DD>The user's prefix and nick.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="equals(java.lang.String)"></A><H3>
- equals</H3>
- <PRE>
- public boolean <B>equals</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> nick)</PRE>
- <DL>
- <DD>Returns true if the nick represented by this User object is the same
- as the argument. A case insensitive comparison is made.
- <P>
- <DD><DL>
- <DT><B>Returns:</B><DD>true if the nicks are identical (case insensitive).</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="equals(java.lang.Object)"></A><H3>
- equals</H3>
- <PRE>
- public boolean <B>equals</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> o)</PRE>
- <DL>
- <DD>Returns true if the nick represented by this User object is the same
- as the nick of the User object given as an argument.
- A case insensitive comparison is made.
- <P>
- <DD><DL>
- <DT><B>Returns:</B><DD>true if o is a User object with a matching lowercase nick.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="hashCode()"></A><H3>
- hashCode</H3>
- <PRE>
- public int <B>hashCode</B>()</PRE>
- <DL>
- <DD>Returns the hash code of this User object.
- <P>
- <DD><DL>
- <DT><B>Returns:</B><DD>the hash code of the User object.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="compareTo(java.lang.Object)"></A><H3>
- compareTo</H3>
- <PRE>
- public int <B>compareTo</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> o)</PRE>
- <DL>
- <DD>Returns the result of calling the compareTo method on lowercased
- nicks. This is useful for sorting lists of User objects.
- <P>
- <DD><DL>
- <DT><B>Returns:</B><DD>the result of calling compareTo on lowercased nicks.</DL>
- </DD>
- </DL>
- <HR>
- <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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/User.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">
- <A HREF="../../../org/jibble/pircbot/Queue.html" title="class in org.jibble.pircbot"><B>PREV CLASS</B></A>
- NEXT CLASS</FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
- <A HREF="User.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
-
- </SCRIPT>
- <NOSCRIPT>
- <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_bottom"></A>
- <HR>
- </BODY>
- </HTML>
|