Log4j 1.3alpha-1

org.apache.log4j.config
Class PropertySetter

java.lang.Object
  |
  +--org.apache.log4j.config.PropertySetter

public class PropertySetter
extends java.lang.Object

General purpose Object property setter. Clients repeatedly invokes setProperty(name,value) in order to invoke setters on the Object specified in the constructor. This class relies on the JavaBeans Introspector to analyze the given Object Class using reflection.

Usage:

     PropertySetter ps = new PropertySetter(anObject);
     ps.set("name", "Joe");
     ps.set("age", "32");
     ps.set("isMale", "true");
   
will cause the invocations anObject.setName("Joe"), anObject.setAge(32), and setMale(true) if such methods exist with those signatures. Otherwise an IntrospectionException are thrown.

Since:
1.1
Author:
Anders Kristensen

Field Summary
static int AS_COLLECTION
           
static int AS_PROPERTY
           
protected  java.beans.MethodDescriptor[] methodDescriptors
           
static int NOT_FOUND
           
protected  java.lang.Object obj
           
protected  java.lang.Class objClass
           
protected  java.beans.PropertyDescriptor[] propertyDescriptors
           
 
Constructor Summary
PropertySetter(java.lang.Object obj)
          Create a new PropertySetter for the specified Object.
 
Method Summary
 void addComponent(java.lang.String name, java.lang.Object childComponent)
           
 int canContainComponent(java.lang.String name)
           
protected  java.lang.Object convertArg(java.lang.String val, java.lang.Class type)
          Convert val a String parameter to an object of a given type.
protected  java.lang.reflect.Method getMethod(java.lang.String methodName)
           
 java.lang.Class getObjClass()
           
protected  java.beans.PropertyDescriptor getPropertyDescriptor(java.lang.String name)
           
protected  void introspect()
          Uses JavaBeans Introspector to computer setters of object to be configured.
 void setComponent(java.lang.String name, java.lang.Object childComponent)
           
static void setProperties(java.lang.Object obj, java.util.Properties properties, java.lang.String prefix)
          Set the properties of an object passed as a parameter in one go.
 void setProperties(java.util.Properties properties, java.lang.String prefix)
          Set the properites for the object that match the prefix passed as parameter.
 void setProperty(java.beans.PropertyDescriptor prop, java.lang.String name, java.lang.String value)
          Set the named property given a PropertyDescriptor.
 void setProperty(java.lang.String name, java.lang.String value)
          Set a property on this PropertySetter's Object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NOT_FOUND

public static final int NOT_FOUND
See Also:
Constant Field Values

AS_PROPERTY

public static final int AS_PROPERTY
See Also:
Constant Field Values

AS_COLLECTION

public static final int AS_COLLECTION
See Also:
Constant Field Values

obj

protected java.lang.Object obj

objClass

protected java.lang.Class objClass

propertyDescriptors

protected java.beans.PropertyDescriptor[] propertyDescriptors

methodDescriptors

protected java.beans.MethodDescriptor[] methodDescriptors
Constructor Detail

PropertySetter

public PropertySetter(java.lang.Object obj)
Create a new PropertySetter for the specified Object. This is done in prepartion for invoking setProperty(java.lang.String, java.lang.String) one or more times.

Parameters:
obj - the object for which to set properties
Method Detail

introspect

protected void introspect()
Uses JavaBeans Introspector to computer setters of object to be configured.


setProperties

public static void setProperties(java.lang.Object obj,
                                 java.util.Properties properties,
                                 java.lang.String prefix)
Set the properties of an object passed as a parameter in one go. The properties are parsed relative to a prefix.

Parameters:
obj - The object to configure.
properties - A java.util.Properties containing keys and values.
prefix - Only keys having the specified prefix will be set.

setProperties

public void setProperties(java.util.Properties properties,
                          java.lang.String prefix)
Set the properites for the object that match the prefix passed as parameter.


setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)
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.

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).

Parameters:
name - name of the property
value - String value of the property

setProperty

public void setProperty(java.beans.PropertyDescriptor prop,
                        java.lang.String name,
                        java.lang.String value)
                 throws PropertySetterException
Set the named property given a PropertyDescriptor.

Parameters:
prop - A PropertyDescriptor describing the characteristics of the property to set.
name - The named of the property to set.
value - The value of the property.
PropertySetterException

canContainComponent

public int canContainComponent(java.lang.String name)

getObjClass

public java.lang.Class getObjClass()

addComponent

public void addComponent(java.lang.String name,
                         java.lang.Object childComponent)

setComponent

public void setComponent(java.lang.String name,
                         java.lang.Object childComponent)

convertArg

protected java.lang.Object convertArg(java.lang.String val,
                                      java.lang.Class type)
Convert val a String parameter to an object of a given type.


getMethod

protected java.lang.reflect.Method getMethod(java.lang.String methodName)

getPropertyDescriptor

protected java.beans.PropertyDescriptor getPropertyDescriptor(java.lang.String name)

Log4j 1.3alpha-1

Copyright 2000-2003 Apache Software Foundation.