core/loggers/ScreenLogger.java

//---PACKAGE DECLARATION---
package uk.org.iscream.cms.server.core.loggers;

//---IMPORTS---
import uk.org.iscream.cms.server.util.*;
import uk.org.iscream.cms.server.core.*;
import java.util.Date;
import java.text.DateFormat;
import java.util.Locale;

/**
 * The ScreenLogger is an implementation of the LoggerImpl defined
 * in the associated interface. It's only purpose is to simply print
 * all the logging information it receives to the screen.
 *
 * @author  $Author: tdb1 $
 * @version $Id: ScreenLogger.java,v 1.6 2001/03/14 23:25:29 tdb1 Exp $
 */
public class ScreenLogger implements LoggerImpl {

//---FINAL ATTRIBUTES---

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

//---CONSTRUCTORS---

    /**
     * Creates a new ScreenLoggerServant.
     */
    public ScreenLogger() {
        write(toString(), Logger.SYSINIT, "started");
    }

//---PUBLIC METHODS---

    /**
         * The write() method takes a line of text, pre-formatted
         * and outputs it using a method defined by the actual
         * implementation. The verbosity is given in case the
         * implementation wishes to utilise it in the layout -
         * eg. a different colour or font.
         *
         * This instance simply prints the message to the screen.
         * 
         * @param line A line of formatted text to be logged
         * @param verbosity the verbosity of this message
         */  
    public synchronized void write(String line, int verbosity) {;
        System.out.println(line);
    }
       
    /**
     * 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---
    
    /**
     * This method is provided if this class wishes to log
     * a message itself.
     *
         * @param source A String representation of the source
         * @param verbosity the verbosity of this message
         * @param message The message to log
         */  
    private void write(String source, int verbosity, String message) {
        write(FormatName.formatLogLine(source, verbosity, message), verbosity);
    }

//---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 = Core.NAME;
    
//---STATIC ATTRIBUTES---
    
}
Revision:	1.7
Committed:	Tue May 29 17:02:35 2001 UTC (22 years, 11 months ago) by tdb
Branch:	MAIN
Branch point for:	SERVER_PIRCBOT
Changes since 1.6:	+6 -6 lines
Log Message:	Major change in the java package naming. This has been held off for some time now, but it really needed doing. The future packaging of all i-scream products will be; uk.org.iscream.<product>.<subpart>.* In the case of the central monitoring system server this will be; uk.org.iscream.cms.server.* The whole server has been changed to follow this structure, and tested to a smallish extent. Further changes in other parts of the CMS will follow.
#	Content
1	//---PACKAGE DECLARATION---
2	package uk.org.iscream.cms.server.core.loggers;
3
4	//---IMPORTS---
5	import uk.org.iscream.cms.server.util.*;
6	import uk.org.iscream.cms.server.core.*;
7	import java.util.Date;
8	import java.text.DateFormat;
9	import java.util.Locale;
10
11	/**
12	* The ScreenLogger is an implementation of the LoggerImpl defined
13	* in the associated interface. It's only purpose is to simply print
14	* all the logging information it receives to the screen.
15	*
16	* @author $Author: tdb1 $
17	* @version $Id: ScreenLogger.java,v 1.6 2001/03/14 23:25:29 tdb1 Exp $
18	*/
19	public class ScreenLogger implements LoggerImpl {
20
21	//---FINAL ATTRIBUTES---
22
23	/**
24	* The current CVS revision of this class
25	*/
26	public final String REVISION = "$Revision: 1.6 $";
27
28	//---STATIC METHODS---
29
30	//---CONSTRUCTORS---
31
32	/**
33	* Creates a new ScreenLoggerServant.
34	*/
35	public ScreenLogger() {
36	write(toString(), Logger.SYSINIT, "started");
37	}
38
39	//---PUBLIC METHODS---
40
41	/**
42	* The write() method takes a line of text, pre-formatted
43	* and outputs it using a method defined by the actual
44	* implementation. The verbosity is given in case the
45	* implementation wishes to utilise it in the layout -
46	* eg. a different colour or font.
47	*
48	* This instance simply prints the message to the screen.
49	*
50	* @param line A line of formatted text to be logged
51	* @param verbosity the verbosity of this message
52	*/
53	public synchronized void write(String line, int verbosity) {;
54	System.out.println(line);
55	}
56
57	/**
58	* Overrides the {@link java.lang.Object#toString() Object.toString()}
59	* method to provide clean logging (every class should have this).
60	*
61	* This uses the uk.org.iscream.cms.server.util.FormatName class
62	* to format the toString()
63	*
64	* @return the name of this class and its CVS revision
65	*/
66	public String toString() {
67	return FormatName.getName(
68	_name,
69	getClass().getName(),
70	REVISION);
71	}
72
73	//---PRIVATE METHODS---
74
75	/**
76	* This method is provided if this class wishes to log
77	* a message itself.
78	*
79	* @param source A String representation of the source
80	* @param verbosity the verbosity of this message
81	* @param message The message to log
82	*/
83	private void write(String source, int verbosity, String message) {
84	write(FormatName.formatLogLine(source, verbosity, message), verbosity);
85	}
86
87	//---ACCESSOR/MUTATOR METHODS---
88
89	//---ATTRIBUTES---
90
91	/**
92	* This is the friendly identifier of the
93	* component this class is running in.
94	* eg, a Filter may be called "filter1",
95	* If this class does not have an owning
96	* component, a name from the configuration
97	* can be placed here. This name could also
98	* be changed to null for utility classes.
99	*/
100	private String _name = Core.NAME;
101
102	//---STATIC ATTRIBUTES---
103
104	}