From 18ee959b108f7b38e556cfd26086da999eee792f Mon Sep 17 00:00:00 2001 From: Robert Burrell Donkin Date: Thu, 3 Jan 2002 18:58:00 +0000 Subject: [PATCH] Same implementation but added long license and java doc comments git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/logging/trunk@138824 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/commons/logging/LogSource.java | 88 +++++++++++++++-- .../org/apache/commons/logging/NoOpLog.java | 96 ++++++++++++++++++- 2 files changed, 172 insertions(+), 12 deletions(-) diff --git a/src/java/org/apache/commons/logging/LogSource.java b/src/java/org/apache/commons/logging/LogSource.java index e617d35..2b6691b 100644 --- a/src/java/org/apache/commons/logging/LogSource.java +++ b/src/java/org/apache/commons/logging/LogSource.java @@ -1,9 +1,62 @@ /* - * Copyright (C) The Apache Software Foundation. All rights reserved. + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//logging/src/java/org/apache/commons/logging/LogSource.java,v 1.5 2002/01/03 18:58:00 rdonkin Exp $ + * $Revision: 1.5 $ + * $Date: 2002/01/03 18:58:00 $ + * + * ==================================================================== + * + * The Apache Software License, Version 1.1 + * + * Copyright (c) 1999-2001 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, if + * any, must include the following acknowlegement: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowlegement may appear in the software itself, + * if and wherever such third-party acknowlegements normally appear. + * + * 4. The names "The Jakarta Project", "Commons", and "Apache Software + * Foundation" must not be used to endorse or promote products derived + * from this software without prior written permission. For written + * permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache" + * nor may "Apache" appear in their names without prior written + * permission of the Apache Group. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . * - * This software is published under the terms of the Apache Software License - * version 1.1, a copy of which has been included with this distribution in - * the LICENSE file. */ package org.apache.commons.logging; @@ -19,11 +72,19 @@ import java.lang.reflect.InvocationTargetException; * of the configured {@link Log} implementation class.

* * @author Rod Waldhoff - * @version $Id: LogSource.java,v 1.4 2001/12/04 04:28:03 craigmcc Exp $ + * @version $Id: LogSource.java,v 1.5 2002/01/03 18:58:00 rdonkin Exp $ */ public class LogSource { + + // --------------------------------------------------------- Class Attributes + static protected HashMap _logs = new HashMap(); + /** Is log4j available (in the current classpath) */ static protected boolean _log4jIsAvailable = false; + + + // --------------------------------------------------------- Class Initializers + static { try { if(null != Class.forName("org.apache.log4j.Category")) { @@ -40,10 +101,14 @@ public class LogSource { } } + /** Constructor for current log class */ static protected Constructor _logimplctor = null; static { try { - setLogImplementation(System.getProperty("org.apache.commons.logging.log","org.apache.commons.logging.NoOpLog")); + setLogImplementation( + System.getProperty( + "org.apache.commons.logging.log","org.apache.commons.logging.NoOpLog")); + } catch(SecurityException e) { _logimplctor = null; } catch(LinkageError e) { @@ -55,9 +120,15 @@ public class LogSource { } } + + // --------------------------------------------------------- Constructor + + /** Don't allow others to create instances */ private LogSource() { } + // --------------------------------------------------------- Class Methods + /** * Set the log implementation/log implementation factory * by the name of the class. The given class @@ -89,6 +160,8 @@ public class LogSource { _logimplctor = logclass.getConstructor(argtypes); } + + /** Get a Log instance by class name */ static public Log getInstance(String name) { Log log = (Log)(_logs.get(name)); if(null == log) { @@ -98,6 +171,7 @@ public class LogSource { return log; } + /** Get a Log instance by class */ static public Log getInstance(Class clazz) { return getInstance(clazz.getName()); } @@ -116,7 +190,7 @@ public class LogSource { * {@link String} argument (containing the name * of the {@link Log} to be constructed. *

- * When httpclient.log is not set, + * When org.apache.commons.logging.log is not set, * or when no corresponding class can be found, * this method will return a {@link Log4JCategoryLog} * if the log4j {@link org.apache.log4j.Category} class is diff --git a/src/java/org/apache/commons/logging/NoOpLog.java b/src/java/org/apache/commons/logging/NoOpLog.java index 1abdc4b..1cb6fb6 100644 --- a/src/java/org/apache/commons/logging/NoOpLog.java +++ b/src/java/org/apache/commons/logging/NoOpLog.java @@ -1,11 +1,65 @@ /* - * Copyright (C) The Apache Software Foundation. All rights reserved. + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//logging/src/java/org/apache/commons/logging/Attic/NoOpLog.java,v 1.7 2002/01/03 18:56:54 rdonkin Exp $ + * $Revision: 1.7 $ + * $Date: 2002/01/03 18:56:54 $ + * + * ==================================================================== + * + * The Apache Software License, Version 1.1 + * + * Copyright (c) 1999-2001 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, if + * any, must include the following acknowlegement: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowlegement may appear in the software itself, + * if and wherever such third-party acknowlegements normally appear. + * + * 4. The names "The Jakarta Project", "Commons", and "Apache Software + * Foundation" must not be used to endorse or promote products derived + * from this software without prior written permission. For written + * permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache" + * nor may "Apache" appear in their names without prior written + * permission of the Apache Group. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . * - * This software is published under the terms of the Apache Software License - * version 1.1, a copy of which has been included with this distribution in - * the LICENSE file. */ + package org.apache.commons.logging; /** @@ -13,23 +67,55 @@ package org.apache.commons.logging; * configurable system properties are supported.

* * @author Rod Waldhoff - * @version $Id: NoOpLog.java,v 1.6 2001/12/04 04:28:03 craigmcc Exp $ + * @version $Id: NoOpLog.java,v 1.7 2002/01/03 18:56:54 rdonkin Exp $ */ public final class NoOpLog implements Log { + + /** Convenience constructor */ public NoOpLog() { } + /** Base constructor */ public NoOpLog(String name) { } + /** Do nothing */ public void debug(Object message) { } + /** Do nothing */ public void debug(Object message, Throwable t) { } + /** Do nothing */ public void info(Object message) { } + /** Do nothing */ public void info(Object message, Throwable t) { } + /** Do nothing */ public void warn(Object message) { } + /** Do nothing */ public void warn(Object message, Throwable t) { } + /** Do nothing */ public void error(Object message) { } + /** Do nothing */ public void error(Object message, Throwable t) { } + /** Do nothing */ public void fatal(Object message) { } + /** Do nothing */ public void fatal(Object message, Throwable t) { } + + /** + * Debug is never enabled. + * + * @return false + */ public final boolean isDebugEnabled() { return false; } + + /** + * Info is never enabled. + * + * @return false + */ public final boolean isInfoEnabled() { return false; } + + /** Do nothing */ public final void setLevel(int level) { } + /** + * Always return off. + * + * @return Log.OFF + */ public final int getLevel() { return Log.OFF; } }