cms/source/TemplateClass.java

/* 
 * i-scream central monitoring system
 * http://www.i-scream.org.uk
 * Copyright (C) 2000-2002 i-scream
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

//---PACKAGE DECLARATION---

//---IMPORTS---
import uk.org.iscream.cms.server.util.*;
import uk.org.iscream.cms.server.componentmanager.*;

/**
 * <ONE LINE DESCRIPTION>
 * <DETAILED DESCRIPTION>
 *
 * @author  $Author: tdb $
 * @version $Id: TemplateClass.java,v 1.13 2002/05/18 18:15:56 tdb Exp $
 */
class TemplateClass {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public static final String REVISION = "$Revision: 1.13 $";
    
//---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.org.iscream.cms.server.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.14
Committed:	Tue May 21 16:47:10 2002 UTC (22 years, 5 months ago) by tdb
Branch:	MAIN
Changes since 1.13:	+3 -2 lines
Log Message:	Added URL to GPL headers.
#	User	Rev	Content
1	tdb	1.13	/*
2			* i-scream central monitoring system
3	tdb	1.14	* http://www.i-scream.org.uk
4	tdb	1.13	* Copyright (C) 2000-2002 i-scream
5			*
6			* This program is free software; you can redistribute it and/or
7			* modify it under the terms of the GNU General Public License
8			* as published by the Free Software Foundation; either version 2
9			* of the License, or (at your option) any later version.
10			*
11			* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU General Public License for more details.
15			*
16			* You should have received a copy of the GNU General Public License
17			* along with this program; if not, write to the Free Software
18			* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19			*/
20
21	ajm	1.1	//---PACKAGE DECLARATION---
22
23			//---IMPORTS---
24	tdb	1.12	import uk.org.iscream.cms.server.util.*;
25			import uk.org.iscream.cms.server.componentmanager.*;
26	ajm	1.1
27			/**
28			* <ONE LINE DESCRIPTION>
29			* <DETAILED DESCRIPTION>
30			*
31	tdb	1.13	* @author $Author: tdb $
32	tdb	1.14	* @version $Id: TemplateClass.java,v 1.13 2002/05/18 18:15:56 tdb Exp $
33	ajm	1.1	*/
34			class TemplateClass {
35	ajm	1.3
36	ajm	1.1	//---FINAL ATTRIBUTES---
37	ajm	1.3
38			/**
39			* The current CVS revision of this class
40			*/
41	tdb	1.14	public static final String REVISION = "$Revision: 1.13 $";
42	ajm	1.3
43	ajm	1.1	//---STATIC METHODS---
44
45			//---CONSTRUCTORS---
46
47			//---PUBLIC METHODS---
48
49			/**
50	tdb	1.4	* Overrides the {@link java.lang.Object#toString() Object.toString()}
51	ajm	1.1	* method to provide clean logging (every class should have this).
52	ajm	1.3	*
53	tdb	1.12	* This uses the uk.org.iscream.cms.server.util.FormatName class
54	ajm	1.8	* to format the toString()
55			*
56	ajm	1.3	* @return the name of this class and its CVS revision
57	ajm	1.1	*/
58			public String toString() {
59	ajm	1.9	return FormatName.getName(
60	ajm	1.8	_name,
61	ajm	1.9	getClass().getName(),
62	ajm	1.6	REVISION);
63	ajm	1.1	}
64
65			//---PRIVATE METHODS---
66
67			//---ACCESSOR/MUTATOR METHODS---
68
69			//---ATTRIBUTES---
70	ajm	1.8
71			/**
72			* This is the friendly identifier of the
73			* component this class is running in.
74			* eg, a Filter may be called "filter1",
75			* If this class does not have an owning
76			* component, a name from the configuration
77			* can be placed here. This name could also
78			* be changed to null for utility classes.
79			*/
80	ajm	1.9	private String _name = <!THIS SHOULD CALL A STATIC NAME IN THE COMPONENT CLASS FOR THIS OBJECT!>;
81	ajm	1.8
82			/**
83			* This holds a reference to the
84			* system logger that is being used.
85			*/
86	ajm	1.9	private Logger _logger = ReferenceManager.getInstance().getLogger();
87	ajm	1.1
88			//---STATIC ATTRIBUTES---
89
90			}