Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> relayirc >> [ chatengine overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.relayirc.chatengine
Class ChannelSearch  

java.lang.Object
  org.relayirc.chatengine.ChannelSearch

---

public class ChannelSearch

extends java.lang.Object

Channel searcher. Works closely with a chat engine to search for channels that match the search criteria, notify listeners of each such matching channel as it is found and build a collection of matching channels.

---

Field Summary
private  boolean	_complete
private  IChatEngine	_engine
private  java.util.Vector	_listeners
private  int	_maxUsers
private  int	_minUsers
private  java.lang.String	_name
private  java.util.Vector	_results

 

Constructor Summary

ChannelSearch(IChatEngine engine)           Channel search needs a chat engine.

 

Method Summary
void	addChannelSearchListener(ChannelSearchListener listener)           Add search listener.
Channel	getChannelAt(int index)           Number of channels found in most recent search, or null on error.
int	getChannelCount()           Number of channels found in most recent search, or -1 on error.
int	getMaxUsers()           Get maximum user-count criteria.
int	getMinUsers()           Get minimum user-count criteria.
java.lang.String	getName()           Get channel name search string.
boolean	isComplete()           True if seach has completed.
(package private)  void	processChannel(Channel chan)           Internal use.
void	removeChannelSearchListener(ChannelSearchListener listener)           Remove search listener.
(package private)  void	searchEnded()           Internal use.
(package private)  void	searchStarted(int channels)           Internal use.
(package private)  void	setComplete(boolean complete)           Internal use.
void	setMaxUsers(int min)           Set maximum user-count criteria.
void	setMinUsers(int min)           Set minimum user-count criteria.
void	setName(java.lang.String name)           Set channel name search string.
void	start()           Start the channel search with the current criteria.

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

_engine

private IChatEngine _engine

---

_name

private java.lang.String _name

---

_minUsers

private int _minUsers

---

_maxUsers

private int _maxUsers

---

_results

private java.util.Vector _results

---

_complete

private boolean _complete

---

_listeners

private java.util.Vector _listeners

Constructor Detail

ChannelSearch

public ChannelSearch(IChatEngine engine)

Channel search needs a chat engine.

Method Detail

getName

public java.lang.String getName()

Get channel name search string.

---

setName

public void setName(java.lang.String name)

Set channel name search string.

---

getMinUsers

public int getMinUsers()

Get minimum user-count criteria.

---

setMinUsers

public void setMinUsers(int min)

Set minimum user-count criteria.

---

getMaxUsers

public int getMaxUsers()

Get maximum user-count criteria.

---

setMaxUsers

public void setMaxUsers(int min)

Set maximum user-count criteria.

---

setComplete

void setComplete(boolean complete)

Internal use.

---

isComplete

public boolean isComplete()

True if seach has completed.

---

getChannelCount

public int getChannelCount()

Number of channels found in most recent search, or -1 on error.

---

getChannelAt

public Channel getChannelAt(int index)

Number of channels found in most recent search, or null on error.

---

start

public void start()

Start the channel search with the current criteria.

---

addChannelSearchListener

public void addChannelSearchListener(ChannelSearchListener listener)

Add search listener.

---

removeChannelSearchListener

public void removeChannelSearchListener(ChannelSearchListener listener)

Remove search listener.

---

processChannel

void processChannel(Channel chan)

Internal use.

---

searchStarted

void searchStarted(int channels)

Internal use.

---

searchEnded

void searchEnded()

Internal use.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> relayirc >> [ chatengine overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---