01: /**
02: * Copyright (C) 2001-2003 France Telecom R&D
03: *
04: * This library is free software; you can redistribute it and/or
05: * modify it under the terms of the GNU Lesser General Public
06: * License as published by the Free Software Foundation; either
07: * version 2 of the License, or (at your option) any later version.
08: *
09: * This library is distributed in the hope that it will be useful,
10: * but WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12: * Lesser General Public License for more details.
13: *
14: * You should have received a copy of the GNU Lesser General Public
15: * License along with this library; if not, write to the Free Software
16: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17: */package org.objectweb.util.monolog.file.api;
18:
19: /**
20: * This interface decribes the special characters used to describe a pattern.
21: * All special characters must be prefix by '%'. Here is an example of
22: * pattern: <br/>
23: * %l %t %m%n <br/>
24: * This pattern will print on a single line the level, the topic name and the
25: * message.
26: *
27: * @author Sebastien Chassande-Barrioz
28: */
29: public interface Pattern {
30:
31: /**
32: * This character represents the level name of the message
33: */
34: char LEVEL = 'l';
35:
36: /**
37: * This character represents the topic of the logger
38: */
39: char TOPIC = 't';
40:
41: /**
42: * This character represents the date where the message has been logged
43: */
44: char DATE = 'd';
45:
46: /**
47: * The theard name which has logged the message.
48: */
49: char THREAD = 'h';
50:
51: /**
52: * The message which has been logged
53: */
54: char MESSAGE = 'm';
55:
56: /**
57: * This character represents the method in which the log method was called.
58: * Generating caller location information is extremly slow.
59: */
60: char METHOD = 'M';
61:
62: /**
63: * This character represents the class name in which the log method was
64: * called. Generating caller location information is extremly slow.
65: */
66: char OBJECT = 'O';
67:
68: /**
69: * This character represents the line number in the source code where the
70: * log method was called. Generating caller location information is
71: * extremly slow.
72: */
73: char LINE_NUMBER = 'L';
74:
75: /**
76: * This character is the prefix of all special character
77: */
78: char PREFIX = '%';
79:
80: /**
81: * This character represents a new line.
82: */
83: char NEW_LINE = 'n';
84:
85: }
|