View Javadoc

1   /*
2    * Copyright 2012 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package org.jboss.netty.logging;
17  
18  /**
19   * <em>Internal-use-only</em> logger used by Netty.  <strong>DO NOT</strong>
20   * access this class outside of Netty.
21   */
22  public interface InternalLogger {
23      /**
24       * Returns {@code true} if a DEBUG level message is logged.
25       */
26      boolean isDebugEnabled();
27  
28      /**
29       * Returns {@code true} if an INFO level message is logged.
30       */
31      boolean isInfoEnabled();
32  
33      /**
34       * Returns {@code true} if a WARN level message is logged.
35       */
36      boolean isWarnEnabled();
37  
38      /**
39       * Returns {@code true} if an ERROR level message is logged.
40       */
41      boolean isErrorEnabled();
42  
43      /**
44       * Returns {@code true} if the specified log level message is logged.
45       */
46      boolean isEnabled(InternalLogLevel level);
47  
48      /**
49       * Logs a DEBUG level message.
50       */
51      void debug(String msg);
52  
53      /**
54       * Logs a DEBUG level message.
55       */
56      void debug(String msg, Throwable cause);
57  
58      /**
59       * Logs an INFO level message.
60       */
61      void info(String msg);
62  
63      /**
64       * Logs an INFO level message.
65       */
66      void info(String msg, Throwable cause);
67  
68      /**
69       * Logs a WARN level message.
70       */
71      void warn(String msg);
72  
73      /**
74       * Logs a WARN level message.
75       */
76      void warn(String msg, Throwable cause);
77  
78      /**
79       * Logs an ERROR level message.
80       */
81      void error(String msg);
82  
83      /**
84       * Logs an ERROR level message.
85       */
86      void error(String msg, Throwable cause);
87  
88      /**
89       * Logs a message.
90       */
91      void log(InternalLogLevel level, String msg);
92  
93      /**
94       * Logs a message.
95       */
96      void log(InternalLogLevel level, String msg, Throwable cause);
97  }