logging-log4j-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From c...@apache.org
Subject cvs commit: jakarta-log4j/src/java/org/apache/log4j/config PropertySetter.java
Date Wed, 17 Sep 2003 15:22:39 GMT
ceki        2003/09/17 08:22:39

  Modified:    src/java/org/apache/log4j/config PropertySetter.java
  Log:
  
  - Removed etra brace casuing compilation to fail
  - Jalopy formatting
  
  Revision  Changes    Path
  1.19      +217 -132  jakarta-log4j/src/java/org/apache/log4j/config/PropertySetter.java
  
  Index: PropertySetter.java
  ===================================================================
  RCS file: /home/cvs/jakarta-log4j/src/java/org/apache/log4j/config/PropertySetter.java,v
  retrieving revision 1.18
  retrieving revision 1.19
  diff -u -r1.18 -r1.19
  --- PropertySetter.java	17 Sep 2003 15:09:08 -0000	1.18
  +++ PropertySetter.java	17 Sep 2003 15:22:38 -0000	1.19
  @@ -1,32 +1,79 @@
   /*
  - * Copyright (C) The Apache Software Foundation. All rights reserved.
  + * ============================================================================
  + *                   The Apache Software License, Version 1.1
  + * ============================================================================
    *
  - * 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.txt file.  */
  -// Contributors:  Georg Lundesgaard
  + *    Copyright (C) 1999 The Apache Software Foundation. All rights reserved.
  + *
  + * Redistribution and use in source and binary forms, with or without modifica-
  + * tion, 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  acknowledgment:  "This product includes  software
  + *    developed  by the  Apache Software Foundation  (http://www.apache.org/)."
  + *    Alternately, this  acknowledgment may  appear in the software itself,  if
  + *    and wherever such third-party acknowledgments normally appear.
  + *
  + * 4. The names "log4j" 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 name,  without prior written permission  of the
  + *    Apache Software Foundation.
  + *
  + * 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 (INCLU-
  + * DING, 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 <http://www.apache.org/>.
  + *
  + */
  +
   
  +// Contributors:  Georg Lundesgaard
   package org.apache.log4j.config;
   
  -import java.beans.Introspector;
  -import java.beans.PropertyDescriptor;
  -import java.beans.MethodDescriptor;
  -import java.beans.BeanInfo;
  -import java.beans.IntrospectionException;
  -import java.lang.reflect.*;
  -import java.util.*;
   import org.apache.log4j.*;
   import org.apache.log4j.helpers.LogLog;
   import org.apache.log4j.helpers.OptionConverter;
   import org.apache.log4j.spi.OptionHandler;
   
  +import java.beans.BeanInfo;
  +import java.beans.IntrospectionException;
  +import java.beans.Introspector;
  +import java.beans.MethodDescriptor;
  +import java.beans.PropertyDescriptor;
  +
  +import java.lang.reflect.*;
  +
  +import java.util.*;
  +
  +
   /**
      General purpose Object property setter. Clients repeatedly invokes
      {@link #setProperty setProperty(name,value)} in order to invoke setters
      on the Object specified in the constructor. This class relies on the
      JavaBeans {@link Introspector} to analyze the given Object Class using
      reflection.
  -   
  +
      <p>Usage:
      <pre>
        PropertySetter ps = new PropertySetter(anObject);
  @@ -37,34 +84,32 @@
      will cause the invocations anObject.setName("Joe"), anObject.setAge(32),
      and setMale(true) if such methods exist with those signatures.
      Otherwise an {@link IntrospectionException} are thrown.
  -  
  +
      @author Anders Kristensen
      @since 1.1
    */
   public class PropertySetter {
  -
  -  static Logger logger = Logger.getLogger("LOG4J."+PropertySetter.class.getName());
  -
  +  static Logger logger =
  +    Logger.getLogger("LOG4J." + PropertySetter.class.getName());
  +  public static final int NOT_FOUND = 0;
  +  public static final int AS_PROPERTY = 1;
  +  public static final int AS_COLLECTION = 2;
     protected Object obj;
     protected Class objClass;
     protected PropertyDescriptor[] propertyDescriptors;
     protected MethodDescriptor[] methodDescriptors;
  -  
  -  static public final int NOT_FOUND     = 0;
  -  static public final int AS_PROPERTY   = 1;
  -  static public final int AS_COLLECTION = 2;
   
     /**
       Create a new PropertySetter for the specified Object. This is done
       in prepartion for invoking {@link #setProperty} one or more times.
  -    
  +
       @param obj  the object for which to set properties
      */
     public PropertySetter(Object obj) {
       this.obj = obj;
       this.objClass = obj.getClass();
     }
  -  
  +
     /**
        Uses JavaBeans {@link Introspector} to computer setters of object to be
        configured.
  @@ -74,14 +119,12 @@
         BeanInfo bi = Introspector.getBeanInfo(obj.getClass());
         propertyDescriptors = bi.getPropertyDescriptors();
         methodDescriptors = bi.getMethodDescriptors();
  -
       } catch (IntrospectionException ex) {
  -      LogLog.error("Failed to introspect "+obj+": " + ex.getMessage());
  +      LogLog.error("Failed to introspect " + obj + ": " + ex.getMessage());
         propertyDescriptors = new PropertyDescriptor[0];
         methodDescriptors = new MethodDescriptor[0];
       }
     }
  -  
   
     /**
        Set the properties of an object passed as a parameter in one
  @@ -92,116 +135,128 @@
        @param properties A java.util.Properties containing keys and values.
        @param prefix Only keys having the specified prefix will be set.
     */
  -  public static void setProperties(Object obj, Properties properties, String prefix) {
  +  public static void setProperties(
  +    Object obj, Properties properties, String prefix) {
       new PropertySetter(obj).setProperties(properties, prefix);
     }
  -  
   
     /**
        Set the properites for the object that match the
        <code>prefix</code> passed as parameter.
   
  -     
  +
      */
     public void setProperties(Properties properties, String prefix) {
       int len = prefix.length();
  -    
  -    for (Enumeration e = properties.propertyNames(); e.hasMoreElements(); ) {
  +
  +    for (Enumeration e = properties.propertyNames(); e.hasMoreElements();) {
         String key = (String) e.nextElement();
  -      
  +
         // handle only properties that start with the desired frefix.
         if (key.startsWith(prefix)) {
  -	// ignore key if it contains dots after the prefix
  +        // ignore key if it contains dots after the prefix
           if (key.indexOf('.', len + 1) > 0) {
  -	  //System.err.println("----------Ignoring---["+key
  -	  //	     +"], prefix=["+prefix+"].");
  -	  continue;
  -	}
  -        
  -	String value = OptionConverter.findAndSubst(key, properties);
  +          //System.err.println("----------Ignoring---["+key
  +          //	     +"], prefix=["+prefix+"].");
  +          continue;
  +        }
  +
  +        String value = OptionConverter.findAndSubst(key, properties);
           key = key.substring(len);
  +
           if ("layout".equals(key) && obj instanceof Appender) {
             continue;
  -        }        
  +        }
  +
           setProperty(key, value);
         }
       }
  -    
  -   
  -    if (obj instanceof OptionHandler) {   
  -         ((OptionHandler) obj).activateOptions(); 
  -       }    
  -     } 
  +
  +    if (obj instanceof OptionHandler) {
  +      ((OptionHandler) obj).activateOptions();
  +    }
     }
  -  
  +
     /**
        Set a property on this PropertySetter's Object. If successful, this
        method will invoke a setter method on the underlying Object. The
        setter is the one for the specified property name and the value is
        determined partly from the setter argument type and partly from the
        value specified in the call to this method.
  -     
  +
        <p>If the setter expects a String no conversion is necessary.
        If it expects an int, then an attempt is made to convert 'value'
        to an int using new Integer(value). If the setter expects a boolean,
        the conversion is by new Boolean(value).
  -     
  +
        @param name    name of the property
        @param value   String value of the property
      */
     public void setProperty(String name, String value) {
  -    if (value == null) return;
  -    
  +    if (value == null) {
  +      return;
  +    }
  +
       name = Introspector.decapitalize(name);
  +
       PropertyDescriptor prop = getPropertyDescriptor(name);
  -    
  -    //LogLog.debug("---------Key: "+name+", type="+prop.getPropertyType());
   
  +    //LogLog.debug("---------Key: "+name+", type="+prop.getPropertyType());
       if (prop == null) {
  -      LogLog.warn("No such property [" + name + "] in "+ objClass.getName()+"." );
  +      LogLog.warn(
  +        "No such property [" + name + "] in " + objClass.getName() + ".");
       } else {
         try {
           setProperty(prop, name, value);
         } catch (PropertySetterException ex) {
  -        LogLog.warn("Failed to set property [" + name +
  -                    "] to value \"" + value + "\". ", ex.rootCause);
  +        LogLog.warn(
  +          "Failed to set property [" + name + "] to value \"" + value + "\". ",
  +          ex.rootCause);
         }
       }
     }
  -  
  -  /** 
  +
  +  /**
         Set the named property given a {@link PropertyDescriptor}.
   
         @param prop A PropertyDescriptor describing the characteristics
         of the property to set.
         @param name The named of the property to set.
  -      @param value The value of the property.      
  +      @param value The value of the property.
      */
     public void setProperty(PropertyDescriptor prop, String name, String value)
       throws PropertySetterException {
       Method setter = prop.getWriteMethod();
  +
       if (setter == null) {
  -      throw new PropertySetterException("No setter for property ["+name+"].");
  +      throw new PropertySetterException(
  +        "No setter for property [" + name + "].");
       }
  +
       Class[] paramTypes = setter.getParameterTypes();
  +
       if (paramTypes.length != 1) {
         throw new PropertySetterException("#params for setter != 1");
       }
  -    
  +
       Object arg;
  +
       try {
         arg = convertArg(value, paramTypes[0]);
       } catch (Throwable t) {
  -      throw new PropertySetterException("Conversion to type ["+paramTypes[0]+
  -					"] failed. Reason: "+t);
  +      throw new PropertySetterException(
  +        "Conversion to type [" + paramTypes[0] + "] failed. Reason: " + t);
       }
  +
       if (arg == null) {
         throw new PropertySetterException(
  -          "Conversion to type ["+paramTypes[0]+"] failed.");
  +        "Conversion to type [" + paramTypes[0] + "] failed.");
       }
  -    LogLog.debug("Setting property [" + name + "] to [" +arg+"].");
  +
  +    LogLog.debug("Setting property [" + name + "] to [" + arg + "].");
  +
       try {
  -      setter.invoke(obj, new Object[]  { arg });
  +      setter.invoke(obj, new Object[] { arg });
       } catch (Exception ex) {
         throw new PropertySetterException(ex);
       }
  @@ -210,22 +265,29 @@
     public int canContainComponent(String name) {
       String cName = capitalizeFirstLetter(name);
   
  +    Method method = getMethod("add" + cName);
   
  +    if (method != null) {
  +      logger.debug(
  +        "Found add" + cName + " method in class " + objClass.getName());
   
  -    Method method = getMethod("add"+cName);
  -    if(method != null) {
  -      logger.debug("Found add"+cName+" method in class "+objClass.getName());
         return AS_COLLECTION;
  -    } 
  +    }
   
       PropertyDescriptor propertyDescriptor = getPropertyDescriptor(name);
  -    if(propertyDescriptor != null) {
  +
  +    if (propertyDescriptor != null) {
         Method setter = propertyDescriptor.getWriteMethod();
  +
         if (setter != null) {
  -	logger.debug("Found setter method for property ["+name+"] in class "+objClass.getName());
  -	return AS_PROPERTY;
  +        logger.debug(
  +          "Found setter method for property [" + name + "] in class "
  +          + objClass.getName());
  +
  +        return AS_PROPERTY;
         }
  -    }     
  +    }
  +
       // we have failed
       return NOT_FOUND;
     }
  @@ -237,87 +299,104 @@
     public void addComponent(String name, Object childComponent) {
       Class ccc = childComponent.getClass();
       name = capitalizeFirstLetter(name);
  -    Method method = getMethod("add"+name);
  +
  +    Method method = getMethod("add" + name);
  +
       // first let us use the addXXX method
  -    if(method != null) {
  +    if (method != null) {
         Class[] params = method.getParameterTypes();
  -      if(params.length == 1) {
  -	if(params[0].isAssignableFrom(childComponent.getClass())) {
  -	  try {
  -	    method.invoke(this.obj, new Object[] {childComponent});
  -	  } catch(Exception e) {
  -	    logger.error("Could not invoke method "+method.getName()
  -			 +" in class "+obj.getClass().getName()
  -			 +" with parameter of type "+ccc.getName(), e);
  -	  }
  -	} else {
  -	  logger.error("A \""+ccc.getName()+
  -		       "\" object is not assignable to a \""+
  -		       params[0].getName() + "\" variable.");
  -	  logger.error("The class \""+ params[0].getName()+"\" was loaded by ");
  -	  logger.error("["+params[0].getClassLoader()+"] whereas object of type ");
  -	  logger.error("\"" +ccc.getName()+"\" was loaded by ["
  -		       +ccc.getClassLoader()+"].");
  -	}
  +
  +      if (params.length == 1) {
  +        if (params[0].isAssignableFrom(childComponent.getClass())) {
  +          try {
  +            method.invoke(this.obj, new Object[] { childComponent });
  +          } catch (Exception e) {
  +            logger.error(
  +              "Could not invoke method " + method.getName() + " in class "
  +              + obj.getClass().getName() + " with parameter of type "
  +              + ccc.getName(), e);
  +          }
  +        } else {
  +          logger.error(
  +            "A \"" + ccc.getName() + "\" object is not assignable to a \""
  +            + params[0].getName() + "\" variable.");
  +          logger.error(
  +            "The class \"" + params[0].getName() + "\" was loaded by ");
  +          logger.error(
  +            "[" + params[0].getClassLoader() + "] whereas object of type ");
  +          logger.error(
  +            "\"" + ccc.getName() + "\" was loaded by [" + ccc.getClassLoader()
  +            + "].");
  +        }
         }
       } else {
  -      logger.error("Could not find method ["+"add"+name+"] in class ["+
  -		   objClass.getName()+"].");
  +      logger.error(
  +        "Could not find method [" + "add" + name + "] in class ["
  +        + objClass.getName() + "].");
       }
     }
   
  -
  -
     public void setComponent(String name, Object childComponent) {
       PropertyDescriptor propertyDescriptor = getPropertyDescriptor(name);
  -    
  -    if(propertyDescriptor == null) {
  -      logger.warn("Could not find PropertyDescriptor for ["+name+"] in "+
  -		  objClass.getName());
  +
  +    if (propertyDescriptor == null) {
  +      logger.warn(
  +        "Could not find PropertyDescriptor for [" + name + "] in "
  +        + objClass.getName());
  +
         return;
       }
  -    
  +
       Method setter = propertyDescriptor.getWriteMethod();
  +
       if (setter == null) {
  -      logger.warn("Not setter method for property ["+name+"] in "+
  -		  obj.getClass().getName());
  +      logger.warn(
  +        "Not setter method for property [" + name + "] in "
  +        + obj.getClass().getName());
  +
         return;
       }
   
       Class[] paramTypes = setter.getParameterTypes();
  +
       if (paramTypes.length != 1) {
  -      logger.error("Wrong number of parameters in setter method for property ["+name+"]
in "+
  -		  obj.getClass().getName());
  -       return;
  +      logger.error(
  +        "Wrong number of parameters in setter method for property [" + name
  +        + "] in " + obj.getClass().getName());
  +
  +      return;
       }
  -    
  +
       try {
  -      setter.invoke(obj, new Object[] {childComponent});
  -      if(logger.isDebugEnabled()) {
  -	logger.debug("Set child component of type [" + childComponent.getClass().getName() 
  -		     + "] for [" +objClass.getName()+"].");
  +      setter.invoke(obj, new Object[] { childComponent });
  +
  +      if (logger.isDebugEnabled()) {
  +        logger.debug(
  +          "Set child component of type ["
  +          + childComponent.getClass().getName() + "] for ["
  +          + objClass.getName() + "].");
         }
       } catch (Exception e) {
  -      logger.error("Could not set component "+obj+" for parent component "+obj, e);
  +      logger.error(
  +        "Could not set component " + obj + " for parent component " + obj, e);
       }
     }
   
  -
     String capitalizeFirstLetter(String name) {
  -    return name.substring(0,1).toUpperCase()+name.substring(1);
  +    return name.substring(0, 1).toUpperCase() + name.substring(1);
     }
  -    
  -  
   
     /**
        Convert <code>val</code> a String parameter to an object of a
        given type.
     */
     protected Object convertArg(String val, Class type) {
  -    if(val == null)
  +    if (val == null) {
         return null;
  +    }
   
       String v = val.trim();
  +
       if (String.class.isAssignableFrom(type)) {
         return val;
       } else if (Integer.TYPE.isAssignableFrom(type)) {
  @@ -333,35 +412,41 @@
       } else if (Priority.class.isAssignableFrom(type)) {
         return OptionConverter.toLevel(v, (Level) Level.DEBUG);
       }
  +
       return null;
     }
  -  
  -  
  +
     protected Method getMethod(String methodName) {
  -    if (methodDescriptors == null) introspect();
  +    if (methodDescriptors == null) {
  +      introspect();
  +    }
   
       for (int i = 0; i < methodDescriptors.length; i++) {
         if (methodName.equals(methodDescriptors[i].getName())) {
  -	return methodDescriptors[i].getMethod();	
  +        return methodDescriptors[i].getMethod();
         }
       }
  -    return null; 
  +
  +    return null;
     }
   
     protected PropertyDescriptor getPropertyDescriptor(String name) {
  -    if (propertyDescriptors == null) introspect();
  -    
  -    for (int i = 0;  i <  propertyDescriptors.length; i++) {
  +    if (propertyDescriptors == null) {
  +      introspect();
  +    }
  +
  +    for (int i = 0; i < propertyDescriptors.length; i++) {
         if (name.equals(propertyDescriptors[i].getName())) {
  -	return propertyDescriptors[i];
  +        return propertyDescriptors[i];
         }
       }
  +
       return null;
     }
  -  
  +
     //public void activate() {
  -    //if (obj instanceof OptionHandler) {
  -      //((OptionHandler) obj).activateOptions();
  -    //}
  +  //if (obj instanceof OptionHandler) {
  +  //((OptionHandler) obj).activateOptions();
  +  //}
     //}
   }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: log4j-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: log4j-dev-help@jakarta.apache.org


Mime
View raw message