cms/source/TemplateClass.java

//---PACKAGE DECLARATION---

//---IMPORTS---
import uk.ac.ukc.iscream.util.NameFormat;
import uk.ac.ukc.iscream.util.ReferenceManager;

/**
 * <ONE LINE DESCRIPTION>
 * <DETAILED DESCRIPTION>
 *
 * @author  $Author: tdb1 $
 * @version $Id: TemplateClass.java,v 1.7 2000/12/07 21:16:10 tdb1 Exp $
 */
class TemplateClass {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public static final String REVISION = "$Revision: 1.7 $";
    
//---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.NameFormat class
     * to format the toString()
     *
     * @return the name of this class and its CVS revision
     */
    public String toString() {
        return NameFormat.getName(
            _name,
            this.getClass().getName(),
            REVISION);
    }

//---PRIVATE 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.
     */
    _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.
     */
    _logger = ReferenceManager.getLogger();

//---STATIC ATTRIBUTES---

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