cms/source/TemplateClass.java

/* 
 * i-scream central monitoring system
 * 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.12 2001/05/29 17:08:10 tdb Exp $
 */
class TemplateClass {

//---FINAL ATTRIBUTES---

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