com.leafdigital.irc.api
Interface IgnoreList

All Superinterfaces:
Singleton

public interface IgnoreList
extends Singleton

Singleton that manages the list of ignored names. Names on this list will have their messages ignored and (if the server supports it) SILENCEd too.


Method Summary
 boolean addMask(IRCUserAddress mask)
          Adds a mask to the ignore list.
 IRCUserAddress[] getMasks()
          Returns the list of masks.
 boolean removeMask(IRCUserAddress mask)
          Removes a mask from the ignore list.
 

Method Detail

addMask

boolean addMask(IRCUserAddress mask)
Adds a mask to the ignore list. (Masks are of the form nick!user@host and may include * wildcards. If you add a mask that doesn't include a !, it assumes it's a nickname. If you add a mask that's already present, nothing happens.)

Parameters:
mask - Mask to add
Returns:
True if mask was added, false if it already exists

removeMask

boolean removeMask(IRCUserAddress mask)
Removes a mask from the ignore list. Has no effect if it isn't there.

Parameters:
mask - Mask to remove
Returns:
True if mask was removed, false if it wasn't there

getMasks

IRCUserAddress[] getMasks()
Returns the list of masks.

Returns:
List of all masks (in arbitrary order)


Copyright © 2011 Samuel Marshall. All rights reserved.