KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > enhydra > shark > api > internal > working > CallbackUtilities


1 package org.enhydra.shark.api.internal.working;
2
3 import java.util.Properties JavaDoc;
4 import org.enhydra.shark.api.RootException;
5
6 /**
7  * CallbackUtilities interface contains properties used for configuration
8  * in Shark.
9  *
10  * @author Sasa Bojanic
11  * @author Vladimir Puskas
12  */

13 public interface CallbackUtilities {
14
15    /**
16     * Returns value of property <i>propertyName</i> used for Shark configuration.
17     *
18     * @param propertyName property name.
19     * @return Value of property <i>propertyName</i>.
20     *
21     */

22    String JavaDoc getProperty (String JavaDoc propertyName);
23
24    /**
25     * Returns value of property <i>propertyName</i> used for Shark configuration.
26     * If doesn't exist the default value is returned.
27     *
28     * @param propertyName property name.
29     * @param defaultValue default property value.
30     * @return Value of property <i>propertyName</i> or default value.
31     *
32     */

33    String JavaDoc getProperty (String JavaDoc propertyName,String JavaDoc defaultValue);
34
35    /**
36     * Returns all properties used for Shark configuration.
37     *
38     * @return Properties object.
39     *
40     */

41    Properties JavaDoc getProperties ();
42
43    /**
44     * Sets properties for Shark configuration.
45     *
46     * @param props Properties object.
47     *
48     */

49    void setProperties (Properties JavaDoc props);
50
51    /**
52     * Log a message object with the <i>ERROR</i> Level.
53     *
54     * @param msg the message to log.
55     *
56     */

57    void error (String JavaDoc msg);
58
59    /**
60     * Log a message object with the <i>ERROR</i> Level.
61     *
62     * @param msg the message to log.
63     * @param ex the exception to log, including its stack trace.
64     *
65     */

66    void error (String JavaDoc msg,RootException ex);
67
68    /**
69     * Log a message object with the <i>ERROR</i> Level.
70     *
71     * @param channel the log channel to be used for logging.
72     * @param msg the message to log.
73     *
74     */

75    void error (String JavaDoc channel,String JavaDoc msg);
76
77    /**
78     * Log a message object with the <i>ERROR</i> Level.
79     *
80     * @param channel the log channel to be used for logging.
81     * @param msg the message to log.
82     * @param ex the exception to log, including its stack trace.
83     *
84     */

85    void error (String JavaDoc channel,String JavaDoc msg,RootException ex);
86
87    /**
88     * Log a message object with the <i>WARN</i> Level.
89     *
90     * @param msg the message to log.
91     *
92     */

93    void warn (String JavaDoc msg);
94
95    /**
96     * Log a message object with the <i>WARN</i> Level.
97     *
98     * @param msg the message to log.
99     * @param ex the exception to log, including its stack trace.
100     *
101     */

102    void warn (String JavaDoc msg,RootException ex);
103
104    /**
105     * Log a message object with the <i>WARN</i> Level.
106     *
107     * @param channel the log channel to be used for logging.
108     * @param msg the message to log.
109     *
110     */

111    void warn (String JavaDoc channel,String JavaDoc msg);
112
113    /**
114     * Log a message object with the <i>WARN</i> Level.
115     *
116     * @param channel the log channel to be used for logging.
117     * @param msg the message to log.
118     * @param ex the exception to log, including its stack trace.
119     *
120     */

121    void warn (String JavaDoc channel,String JavaDoc msg,RootException ex);
122
123    /**
124     * Log a message object with the <i>INFO</i> Level.
125     *
126     * @param msg the message to log.
127     *
128     */

129    void info (String JavaDoc msg);
130
131    /**
132     * Log a message object with the <i>INFO</i> Level.
133     *
134     * @param msg the message to log.
135     * @param ex the exception to log, including its stack trace.
136     *
137     */

138    void info (String JavaDoc msg,RootException ex);
139
140    /**
141     * Log a message object with the <i>INFO</i> Level.
142     *
143     * @param channel the log channel to be used for logging.
144     * @param msg the message to log.
145     *
146     */

147    void info (String JavaDoc channel,String JavaDoc msg);
148
149    /**
150     * Log a message object with the <i>INFO</i> Level.
151     *
152     * @param channel the log channel to be used for logging.
153     * @param msg the message to log.
154     * @param ex the exception to log, including its stack trace.
155     *
156     */

157    void info (String JavaDoc channel,String JavaDoc msg,RootException ex);
158
159    /**
160     * Log a message object with the <i>DEBUG</i> level.
161     *
162     * @param msg the message to log.
163     *
164     */

165    void debug (String JavaDoc msg);
166
167    /**
168     * Log a message object with the <i>DEBUG</i> level.
169     *
170     * @param msg the message to log.
171     * @param ex the exception to log, including its stack trace.
172     *
173     */

174    void debug (String JavaDoc msg,RootException ex);
175
176    /**
177     * Log a message object with the <i>DEBUG</i> level.
178     *
179     * @param channel the log channel to be used for logging.
180     * @param msg the message to log.
181     *
182     */

183    void debug (String JavaDoc channel,String JavaDoc msg);
184
185    /**
186     * Log a message object with the <i>DEBUG</i> level.
187     *
188     * @param channel the log channel to be used for logging.
189     * @param msg the message to log.
190     * @param ex the exception to log, including its stack trace.
191     *
192     */

193    void debug (String JavaDoc channel,String JavaDoc msg,RootException ex);
194
195
196 }
197
198
Popular Tags