1 package org.eclipse.aether.spi.log;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 /**
23 * A simple logger to facilitate emission of diagnostic messages. In general, unrecoverable errors should be reported
24 * via exceptions and informational notifications should be reported via events, hence this logger interface focuses on
25 * support for tracing.
26 */
27 public interface Logger
28 {
29
30 /**
31 * Indicates whether debug logging is enabled.
32 *
33 * @return {@code true} if debug logging is enabled, {@code false} otherwise.
34 */
35 boolean isDebugEnabled();
36
37 /**
38 * Emits the specified message.
39 *
40 * @param msg The message to log, must not be {@code null}.
41 */
42 void debug( String msg );
43
44 /**
45 * Emits the specified message along with a stack trace of the given exception.
46 *
47 * @param msg The message to log, must not be {@code null}.
48 * @param error The exception to log, may be {@code null}.
49 */
50 void debug( String msg, Throwable error );
51
52 /**
53 * Indicates whether warn logging is enabled.
54 *
55 * @return {@code true} if warn logging is enabled, {@code false} otherwise.
56 */
57 boolean isWarnEnabled();
58
59 /**
60 * Emits the specified message.
61 *
62 * @param msg The message to log, must not be {@code null}.
63 */
64 void warn( String msg );
65
66 /**
67 * Emits the specified message along with a stack trace of the given exception.
68 *
69 * @param msg The message to log, must not be {@code null}.
70 * @param error The exception to log, may be {@code null}.
71 */
72 void warn( String msg, Throwable error );
73
74 }