agents/template/TemplateClass.java

//---PACKAGE DECLARATION---

//---IMPORTS---

/**
 * <ONE LINE DESCRIPTION>
 * <DETAILED DESCRIPTION>
 *
 * @author  $Author: tdb1 $
 * @version $Id: TemplateClass.java,v 1.11 2001/03/22 21:50:41 tdb1 Exp $
 */
class TemplateClass {

//---FINAL / FINAL STATIC ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public static final String REVISION = "$Revision: 1.11 $";
    
//---STATIC METHODS---

//---CONSTRUCTORS---

//---PUBLIC METHODS---

    /**
     * Overrides the {@link java.lang.Object#toString() Object.toString()}
     * method to provide clean logging (every class should have this).
     *
     * This uses the uk.ac.ukc.iscream.util.FormatName class
     * to format the toString()
     *
     * @return the name of this class and its CVS revision
     */
    public String toString() {
        return FormatName.getName(
            _name,
            getClass().getName(),
            REVISION);
    }

//---PRIVATE/PROTECTED METHODS---

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

//---ATTRIBUTES---

    /**
     * This is the friendly identifier of the
     * component this class is running in.
     * eg, a Filter may be called "filter1",
     * If this class does not have an owning
     * component,  a name from the configuration
     * can be placed here.  This name could also
     * be changed to null for utility classes.
     */
    private String _name = <!THIS SHOULD CALL A STATIC NAME IN THE COMPONENT CLASS FOR THIS OBJECT!>;

    /**
     * This holds a reference to the
     * system logger that is being used.
     */
    private Logger _logger = Logger.getInstance();

//---STATIC ATTRIBUTES---

}
Revision:	1.1
Committed:	Fri May 4 19:03:34 2001 UTC (24 years, 6 months ago) by ajm
Branch:	MAIN
CVS Tags:	HEAD
Log Message:	slight modifications to the general areas of the standard template to clearly define where protected and static final items should appear. Also modified to be specific for the Agents system.
#	User	Rev	Content
1	ajm	1.1	//---PACKAGE DECLARATION---
2
3			//---IMPORTS---
4
5			/**
6			* <ONE LINE DESCRIPTION>
7			* <DETAILED DESCRIPTION>
8			*
9			* @author $Author: tdb1 $
10			* @version $Id: TemplateClass.java,v 1.11 2001/03/22 21:50:41 tdb1 Exp $
11			*/
12			class TemplateClass {
13
14			//---FINAL / FINAL STATIC ATTRIBUTES---
15
16			/**
17			* The current CVS revision of this class
18			*/
19			public static final String REVISION = "$Revision: 1.11 $";
20
21			//---STATIC METHODS---
22
23			//---CONSTRUCTORS---
24
25			//---PUBLIC METHODS---
26
27			/**
28			* Overrides the {@link java.lang.Object#toString() Object.toString()}
29			* method to provide clean logging (every class should have this).
30			*
31			* This uses the uk.ac.ukc.iscream.util.FormatName class
32			* to format the toString()
33			*
34			* @return the name of this class and its CVS revision
35			*/
36			public String toString() {
37			return FormatName.getName(
38			_name,
39			getClass().getName(),
40			REVISION);
41			}
42
43			//---PRIVATE/PROTECTED METHODS---
44
45			//---ACCESSOR/MUTATOR METHODS---
46
47			//---ATTRIBUTES---
48
49			/**
50			* This is the friendly identifier of the
51			* component this class is running in.
52			* eg, a Filter may be called "filter1",
53			* If this class does not have an owning
54			* component, a name from the configuration
55			* can be placed here. This name could also
56			* be changed to null for utility classes.
57			*/
58			private String _name = <!THIS SHOULD CALL A STATIC NAME IN THE COMPONENT CLASS FOR THIS OBJECT!>;
59
60			/**
61			* This holds a reference to the
62			* system logger that is being used.
63			*/
64			private Logger _logger = Logger.getInstance();
65
66			//---STATIC ATTRIBUTES---
67
68			}