cms/source/TemplateClass.java

//---PACKAGE DECLARATION---

//---IMPORTS---
import uk.ac.ukc.iscream.util.*;

/**
 * <ONE LINE DESCRIPTION>
 * <DETAILED DESCRIPTION>
 *
 * @author  $Author: ajm4 $
 * @version $Id: TemplateClass.java,v 1.8 2000/12/08 11:44:34 ajm4 Exp $
 */
class TemplateClass {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public static final String REVISION = "$Revision: 1.8 $";
    
//---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 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 = ReferenceManager.getInstance().getLogger();

//---STATIC ATTRIBUTES---

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