1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
package org.apache.maven.plugin.logging;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* This interface supplies the API for providing feedback to the user from the <code>Mojo</code>, using standard
* <code>Maven</code> channels.
* <br/>
* There should be no big surprises here, although you may notice that the methods accept
* <code>java.lang.CharSequence</code> rather than <code>java.lang.String</code>. This is provided mainly as a
* convenience, to enable developers to pass things like <code>java.lang.StringBuffer</code> directly into the logger,
* rather than formatting first by calling <code>toString()</code>.
*
* @author jdcasey
*/
public interface Log
{
/**
* @return true if the <b>debug</b> error level is enabled
*/
boolean isDebugEnabled();
/**
* Send a message to the user in the <b>debug</b> error level.
*
* @param content
*/
void debug( CharSequence content );
/**
* Send a message (and accompanying exception) to the user in the <b>debug</b> error level.
* <br/>
* The error's stacktrace will be output when this error level is enabled.
*
* @param content
* @param error
*/
void debug( CharSequence content, Throwable error );
/**
* Send an exception to the user in the <b>debug</b> error level.
* <br/>
* The stack trace for this exception will be output when this error level is enabled.
*
* @param error
*/
void debug( Throwable error );
/**
* @return true if the <b>info</b> error level is enabled
*/
boolean isInfoEnabled();
/**
* Send a message to the user in the <b>info</b> error level.
*
* @param content
*/
void info( CharSequence content );
/**
* Send a message (and accompanying exception) to the user in the <b>info</b> error level.
* <br/>
* The error's stacktrace will be output when this error level is enabled.
*
* @param content
* @param error
*/
void info( CharSequence content, Throwable error );
/**
* Send an exception to the user in the <b>info</b> error level.
* <br/>
* The stack trace for this exception will be output when this error level is enabled.
*
* @param error
*/
void info( Throwable error );
/**
* @return true if the <b>warn</b> error level is enabled
*/
boolean isWarnEnabled();
/**
* Send a message to the user in the <b>warn</b> error level.
*
* @param content
*/
void warn( CharSequence content );
/**
* Send a message (and accompanying exception) to the user in the <b>warn</b> error level.
* <br/>
* The error's stacktrace will be output when this error level is enabled.
*
* @param content
* @param error
*/
void warn( CharSequence content, Throwable error );
/**
* Send an exception to the user in the <b>warn</b> error level.
* <br/>
* The stack trace for this exception will be output when this error level is enabled.
*
* @param error
*/
void warn( Throwable error );
/**
* @return true if the <b>error</b> error level is enabled
*/
boolean isErrorEnabled();
/**
* Send a message to the user in the <b>error</b> error level.
*
* @param content
*/
void error( CharSequence content );
/**
* Send a message (and accompanying exception) to the user in the <b>error</b> error level.
* <br/>
* The error's stacktrace will be output when this error level is enabled.
*
* @param content
* @param error
*/
void error( CharSequence content, Throwable error );
/**
* Send an exception to the user in the <b>error</b> error level.
* <br/>
* The stack trace for this exception will be output when this error level is enabled.
*
* @param error
*/
void error( Throwable error );
}
|
