com.leafdigital.irc.api
Class IRCUserAddress

java.lang.Object
  extended by com.leafdigital.irc.api.IRCUserAddress
All Implemented Interfaces:
java.lang.Comparable<java.lang.Object>

public class IRCUserAddress
extends java.lang.Object
implements java.lang.Comparable<java.lang.Object>

Address of a user in "nick (exclamation) user (at) host" format.

Note: This implements Comparable for compatibility reasons; implementing Comparable would remove binary compatibility with earlier versions.


Constructor Summary
IRCUserAddress(java.lang.String text, boolean pattern)
          Constructs from a string in format "nick (exclamation) user (at) host".
IRCUserAddress(java.lang.String nick, java.lang.String user, java.lang.String host)
           
 
Method Summary
 int compareTo(java.lang.Object obj)
          IRCUserAddress is sorted by nickname, username, then host.
 boolean equals(java.lang.Object o)
           
 java.lang.String getHost()
           
 java.lang.String getNick()
           
 java.lang.String getUser()
           
 int hashCode()
           
 boolean matches(IRCUserAddress pattern)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IRCUserAddress

public IRCUserAddress(java.lang.String text,
                      boolean pattern)
Constructs from a string in format "nick (exclamation) user (at) host". All parts are optional; if there's no ! then it will only be a nick, no @ then nick!user.

Parameters:
text - User address in appropriate string format
pattern - If true, parts that would otherwise be blank become *

IRCUserAddress

public IRCUserAddress(java.lang.String nick,
                      java.lang.String user,
                      java.lang.String host)
Parameters:
nick - Nickname
user - Username
host - Hostname
Method Detail

getNick

public java.lang.String getNick()
Returns:
Nickname

getUser

public java.lang.String getUser()
Returns:
Username

getHost

public java.lang.String getHost()
Returns:
Hostname

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
Returns:
IRC mask string, "nick (exclamation) user (at) host"

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object
Parameters:
o - Comparison object
Returns:
True if the three parts are equal (ignoring case)

compareTo

public int compareTo(java.lang.Object obj)
              throws java.lang.ClassCastException
IRCUserAddress is sorted by nickname, username, then host.

Specified by:
compareTo in interface java.lang.Comparable<java.lang.Object>
Parameters:
obj - Comparison object
Returns:
Positive if this one is later than the comparison o
Throws:
java.lang.ClassCastException - If obj is not an IRCUserAddress

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object
Returns:
Hash code based on lower-case version of address

matches

public boolean matches(IRCUserAddress pattern)
Parameters:
pattern - Another IRCUserAddress which may include * wildcards
Returns:
True if this address matches the pattern


Copyright © 2011 Samuel Marshall. All rights reserved.