1    
2    /*
3     * ====================================================================
4     * The Apache Software License, Version 1.1
5     *
6     * Copyright (c) 2002 The Apache Software Foundation.  All rights
7     * reserved.
8     *
9     * Redistribution and use in source and binary forms, with or without
10    * modification, are permitted provided that the following conditions
11    * are met:
12    *
13    * 1. Redistributions of source code must retain the above copyright
14    *    notice, this list of conditions and the following disclaimer.
15    *
16    * 2. Redistributions in binary form must reproduce the above copyright
17    *    notice, this list of conditions and the following disclaimer in
18    *    the documentation and/or other materials provided with the
19    *    distribution.
20    *
21    * 3. The end-user documentation included with the redistribution,
22    *    if any, must include the following acknowledgment:
23    *       "This product includes software developed by the
24    *        Apache Software Foundation (http://www.apache.org/)."
25    *    Alternately, this acknowledgment may appear in the software itself,
26    *    if and wherever such third-party acknowledgments normally appear.
27    *
28    * 4. The names "Apache" and "Apache Software Foundation" and
29    *    "Apache POI" must not be used to endorse or promote products
30    *    derived from this software without prior written permission. For
31    *    written permission, please contact apache@apache.org.
32    *
33    * 5. Products derived from this software may not be called "Apache",
34    *    "Apache POI", nor may "Apache" appear in their name, without
35    *    prior written permission of the Apache Software Foundation.
36    *
37    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48    * SUCH DAMAGE.
49    * ====================================================================
50    *
51    * This software consists of voluntary contributions made by many
52    * individuals on behalf of the Apache Software Foundation.  For more
53    * information on the Apache Software Foundation, please see
54    * <http://www.apache.org/>.
55    */
56   package org.apache.poi.util;
57   
58   import org.apache.commons.logging.Log;
59   import org.apache.commons.logging.LogFactory;
60   
61   import java.util.*;
62   
63   /**
64    * A logger class that strives to make it as easy as possible for
65    * developers to write log calls, while simultaneously making those
66    * calls as cheap as possible by performing lazy evaluation of the log
67    * message.<p>
68    *
69    * @author Marc Johnson (mjohnson at apache dot org)
70    * @author Glen Stampoultzis (glens at apache.org)
71    * @author Nicola Ken Barozzi (nicolaken at apache.org)
72    */
73   
74   public class CommonsLogger extends POILogger
75   {
76   
77       private static LogFactory   _creator = LogFactory.getFactory();
78       private Log             log   = null;
79   
80      
81       public void initialize(final String cat)
82       {
83           this.log = _creator.getInstance(cat);
84       }   
85        
86       /**
87        * Log a message
88        *
89        * @param level One of DEBUG, INFO, WARN, ERROR, FATAL
90        * @param obj1 The object to log.
91        */
92   
93       public void log(final int level, final Object obj1)
94       {
95           if(level==FATAL)
96           {
97             if(log.isFatalEnabled())
98             {
99               log.fatal(obj1);
100            }
101          }
102          else if(level==ERROR)
103          {
104            if(log.isErrorEnabled())
105            {
106              log.error(obj1);
107            }
108          }
109          else if(level==WARN)
110          {
111            if(log.isWarnEnabled())
112            {
113              log.warn(obj1);
114            }
115          }
116          else if(level==INFO)
117          {
118            if(log.isInfoEnabled())
119            {
120              log.info(obj1);
121            }
122          }
123          else if(level==DEBUG)
124          {
125            if(log.isDebugEnabled())
126            {
127              log.debug(obj1);
128            }
129          }
130          else
131          {
132            if(log.isTraceEnabled())
133            {
134              log.trace(obj1);
135            }
136          }
137  
138      }
139  
140      /**
141       * Check if a logger is enabled to log at the specified level
142       *
143       * @param level One of DEBUG, INFO, WARN, ERROR, FATAL
144       * @param obj1 The logger to check.
145       */
146  
147      public boolean check(final int level)
148      {
149          if(level==FATAL)
150          {
151            if(log.isFatalEnabled())
152            {
153              return true;
154            }
155          }
156          else if(level==ERROR)
157          {
158            if(log.isErrorEnabled())
159            {
160              return true;
161            }
162          }
163          else if(level==WARN)
164          {
165            if(log.isWarnEnabled())
166            {
167              return true;
168            }
169          }
170          else if(level==INFO)
171          {
172            if(log.isInfoEnabled())
173            {
174              return true;
175            }
176          }
177          else if(level==DEBUG)
178          {
179            if(log.isDebugEnabled())
180            {
181              return true;
182            }
183          }
184  
185          return false;
186  
187      }
188  
189   
190  }   // end package scope class POILogger
191  
192