server/client/PluginAlerter.java

//---PACKAGE DECLARATION---
package uk.org.iscream.client;

//---IMPORTS---

/**
 * An interface to which a Alerters must adhere.
 *
 * This is extended by the AlerterSkeleton, Alerters should
 * typically extend this class to be a fully functional Alerter.
 *
 * @author  $Author: ajm4 $
 * @version $Id: PluginAlerter.java,v 1.4 2001/03/22 22:07:14 ajm4 Exp $
 */
public interface PluginAlerter {

//---STATIC METHODS---

//---CONSTRUCTORS---

//---PUBLIC METHODS---
   
    /**
     * Gives a description of what this PluginAlerter does
     *
     * @return the description
     */
    public String getDescription();

//---PRIVATE METHODS---

//---ACCESSOR/MUTATOR METHODS---

}
Revision:	1.5
Committed:	Fri Mar 23 02:30:44 2001 UTC (23 years, 2 months ago) by ajm
Branch:	MAIN
CVS Tags:	PROJECT_COMPLETION
Changes since 1.4:	+6 -3 lines
Log Message:	Javadoc'd the whole bally lot.
#	User	Rev	Content
1	tdb	1.1	//---PACKAGE DECLARATION---
2	tdb	1.3	package uk.org.iscream.client;
3	tdb	1.1
4			//---IMPORTS---
5
6			/**
7	ajm	1.5	* An interface to which a Alerters must adhere.
8	tdb	1.1	*
9	ajm	1.5	* This is extended by the AlerterSkeleton, Alerters should
10			* typically extend this class to be a fully functional Alerter.
11			*
12			* @author $Author: ajm4 $
13			* @version $Id: PluginAlerter.java,v 1.4 2001/03/22 22:07:14 ajm4 Exp $
14	tdb	1.1	*/
15	tdb	1.2	public interface PluginAlerter {
16	tdb	1.1
17			//---STATIC METHODS---
18
19			//---CONSTRUCTORS---
20
21			//---PUBLIC METHODS---
22	ajm	1.4
23	tdb	1.1	/**
24			* Gives a description of what this PluginAlerter does
25			*
26			* @return the description
27			*/
28			public String getDescription();
29
30			//---PRIVATE METHODS---
31
32			//---ACCESSOR/MUTATOR METHODS---
33
34			}