Find Usages Diff Raw Download HTML Widget
Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions 
1
  /*
2
   * Licensed to the Apache Software Foundation (ASF) under one or more
3
   * contributor license agreements.  See the NOTICE file distributed with
4
   * this work for additional information regarding copyright ownership.
5
   * The ASF licenses this file to You under the Apache License, Version 2.0
6
   * (the "License"); you may not use this file except in compliance with
7
   * the License.  You may obtain a copy of the License at
8
   * 
9
   *      http://www.apache.org/licenses/LICENSE-2.0
10
  * 
11
  * Unless required by applicable law or agreed to in writing, software
12
  * distributed under the License is distributed on an "AS IS" BASIS,
13
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
  * See the License for the specific language governing permissions and
15
  * limitations under the License.
16
  */ 
17
 
18
 
19
 package org.apache.commons.logging;

A simple logging interface abstracting logging APIs. In order to be instantiated successfully by LogFactory, classes that implement this interface must have a constructor that takes a single String parameter representing the "name" of this Log.

The six logging levels used by Log are (in order):

  1. trace (the least serious)
  2. debug
  3. info
  4. warn
  5. error
  6. fatal (the most serious)
The mapping of these log levels to the concepts used by the underlying logging system is implementation dependent. The implemention should ensure, though, that this ordering behaves as expected.

Performance is often a logging concern. By examining the appropriate property, a component can avoid expensive operations (producing information to be logged).

For example, 

    if (log.isDebugEnabled()) {
        ... do something expensive ...
        log.debug(theResult);
    }

Configuration of the underlying logging system will generally be done external to the Logging APIs, through whatever mechanism is supported by that system.

Author(s):
Scott Sanders
Rod Waldhoff
Version:
$Id: Log.java 424107 2006-07-20 23:15:42Z skitching $
62
 
63
 public interface Log {
64
 
65
 
66
     // ----------------------------------------------------- Logging Properties
67
 

    

Is debug logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than debug.

Returns:
true if debug is enabled in the underlying logger.
77
 
78
     public boolean isDebugEnabled();


    

Is error logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than error.

Returns:
true if error is enabled in the underlying logger.
89
 
90
     public boolean isErrorEnabled();


    

Is fatal logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than fatal.

Returns:
true if fatal is enabled in the underlying logger.
102
    public boolean isFatalEnabled();


    

Is info logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than info.

Returns:
true if info is enabled in the underlying logger.
114
    public boolean isInfoEnabled();


    

Is trace logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than trace.

Returns:
true if trace is enabled in the underlying logger.
126
    public boolean isTraceEnabled();


    

Is warn logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than warn.

Returns:
true if warn is enabled in the underlying logger.
138
    public boolean isWarnEnabled();
141
    // -------------------------------------------------------- Logging Methods
142


    

Log a message with trace log level.

Parameters:
message log this message
149
    public void trace(Object message);


    

Log an error with trace log level.

Parameters:
message log this message
t log this cause
158
    public void trace(Object message, Throwable t);


    

Log a message with debug log level.

Parameters:
message log this message
166
    public void debug(Object message);


    

Log an error with debug log level.

Parameters:
message log this message
t log this cause
175
    public void debug(Object message, Throwable t);


    

Log a message with info log level.

Parameters:
message log this message
183
    public void info(Object message);


    

Log an error with info log level.

Parameters:
message log this message
t log this cause
192
    public void info(Object message, Throwable t);


    

Log a message with warn log level.

Parameters:
message log this message
200
    public void warn(Object message);


    

Log an error with warn log level.

Parameters:
message log this message
t log this cause
209
    public void warn(Object message, Throwable t);


    

Log a message with error log level.

Parameters:
message log this message
217
    public void error(Object message);


    

Log an error with error log level.

Parameters:
message log this message
t log this cause
226
    public void error(Object message, Throwable t);


    

Log a message with fatal log level.

Parameters:
message log this message
234
    public void fatal(Object message);


    

Log an error with fatal log level.

Parameters:
message log this message
t log this cause
243
    public void fatal(Object message, Throwable t);
New to GrepCode? Check out our FAQ X