| /* |
| * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//digester/src/java/org/apache/commons/digester/SetRootRule.java,v 1.6 2002/08/05 20:52:30 craigmcc Exp $ |
| * $Revision: 1.6 $ |
| * $Date: 2002/08/05 20:52:30 $ |
| * |
| * ==================================================================== |
| * |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 1999-2002 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 |
| * <http://www.apache.org/>. |
| * |
| */ |
| |
| |
| package org.apache.commons.digester; |
| |
| |
| import java.lang.ClassLoader; |
| import java.lang.reflect.Method; |
| |
| import org.xml.sax.Attributes; |
| import org.apache.commons.beanutils.MethodUtils; |
| |
| |
| /** |
| * <p>Rule implementation that calls a method on the root object on the stack, |
| * passing the top object (child) as an argument. |
| * It is important to remember that this rule acts on <code>end</code>.</p> |
| * |
| * <p>This rule now supports more flexible method matching by default. |
| * It is possible that this may break (some) code |
| * written against release 1.1.1 or earlier. |
| * See {@link #isExactMatch()} for more details.</p> |
| * |
| * @author Scott Sanders |
| * @version $Revision: 1.6 $ $Date: 2002/08/05 20:52:30 $ |
| */ |
| |
| public class SetRootRule extends Rule { |
| |
| |
| // ----------------------------------------------------------- Constructors |
| |
| |
| /** |
| * Construct a "set root" rule with the specified method name. The |
| * method's argument type is assumed to be the class of the |
| * child object. |
| * |
| * @param digester The associated Digester |
| * @param methodName Method name of the parent method to call |
| * |
| * @deprecated The digester instance is now set in the {@link Digester#addRule} method. |
| * Use {@link #SetRootRule(String methodName)} instead. |
| */ |
| public SetRootRule(Digester digester, String methodName) { |
| |
| this(methodName); |
| |
| } |
| |
| |
| /** |
| * Construct a "set root" rule with the specified method name. |
| * |
| * @param digester The associated Digester |
| * @param methodName Method name of the parent method to call |
| * @param paramType Java class of the parent method's argument |
| * (if you wish to use a primitive type, specify the corresonding |
| * Java wrapper class instead, such as <code>java.lang.Boolean</code> |
| * for a <code>boolean</code> parameter) |
| * |
| * @deprecated The digester instance is now set in the {@link Digester#addRule} method. |
| * Use {@link #SetRootRule(String methodName,String paramType)} instead. |
| */ |
| public SetRootRule(Digester digester, String methodName, |
| String paramType) { |
| |
| this(methodName, paramType); |
| |
| } |
| |
| /** |
| * Construct a "set root" rule with the specified method name. The |
| * method's argument type is assumed to be the class of the |
| * child object. |
| * |
| * @param methodName Method name of the parent method to call |
| */ |
| public SetRootRule(String methodName) { |
| |
| this(methodName, null); |
| |
| } |
| |
| |
| /** |
| * Construct a "set root" rule with the specified method name. |
| * |
| * @param methodName Method name of the parent method to call |
| * @param paramType Java class of the parent method's argument |
| * (if you wish to use a primitive type, specify the corresonding |
| * Java wrapper class instead, such as <code>java.lang.Boolean</code> |
| * for a <code>boolean</code> parameter) |
| */ |
| public SetRootRule(String methodName, |
| String paramType) { |
| |
| this.methodName = methodName; |
| this.paramType = paramType; |
| |
| } |
| |
| // ----------------------------------------------------- Instance Variables |
| |
| |
| /** |
| * The method name to call on the parent object. |
| */ |
| protected String methodName = null; |
| |
| |
| /** |
| * The Java class name of the parameter type expected by the method. |
| */ |
| protected String paramType = null; |
| |
| /** |
| * Should we use exact matching. Default is no. |
| */ |
| protected boolean useExactMatch = false; |
| |
| |
| // --------------------------------------------------------- Public Methods |
| |
| |
| /** |
| * <p>Is exact matching being used.</p> |
| * |
| * <p>This rule uses <code>org.apache.commons.beanutils.MethodUtils</code> |
| * to introspect the relevent objects so that the right method can be called. |
| * Originally, <code>MethodUtils.invokeExactMethod</code> was used. |
| * This matches methods very strictly |
| * and so may not find a matching method when one exists. |
| * This is still the behaviour when exact matching is enabled.</p> |
| * |
| * <p>When exact matching is disabled, <code>MethodUtils.invokeMethod</code> is used. |
| * This method finds more methods but is less precise when there are several methods |
| * with correct signatures. |
| * So, if you want to choose an exact signature you might need to enable this property.</p> |
| * |
| * <p>The default setting is to disable exact matches.</p> |
| * |
| * @return true iff exact matching is enabled |
| * @since Digester Release 1.1.1 |
| */ |
| public boolean isExactMatch() { |
| |
| return useExactMatch; |
| } |
| |
| |
| /** |
| * <p>Set whether exact matching is enabled.</p> |
| * |
| * <p>See {@link #isExactMatch()}.</p> |
| * |
| * @param useExactMatch should this rule use exact method matching |
| * @since Digester Release 1.1.1 |
| */ |
| public void setExactMatch(boolean useExactMatch) { |
| |
| this.useExactMatch = useExactMatch; |
| } |
| |
| /** |
| * Process the end of this element. |
| */ |
| public void end() throws Exception { |
| |
| // Identify the objects to be used |
| Object child = digester.peek(0); |
| Object parent = digester.root; |
| if (digester.log.isDebugEnabled()) { |
| if (parent == null) { |
| digester.log.debug("[SetRootRule]{" + digester.match + |
| "} Call [NULL ROOT]." + |
| methodName + "(" + child + ")"); |
| } else { |
| digester.log.debug("[SetRootRule]{" + digester.match + |
| "} Call " + parent.getClass().getName() + "." + |
| methodName + "(" + child + ")"); |
| } |
| } |
| |
| // Call the specified method |
| Class paramTypes[] = new Class[1]; |
| if (paramType != null) { |
| paramTypes[0] = |
| digester.getClassLoader().loadClass(paramType); |
| } else { |
| paramTypes[0] = child.getClass(); |
| } |
| |
| if (useExactMatch) { |
| |
| MethodUtils.invokeExactMethod(parent, methodName, |
| new Object[]{ child }, paramTypes); |
| |
| } else { |
| |
| MethodUtils.invokeMethod(parent, methodName, |
| new Object[]{ child }, paramTypes); |
| |
| } |
| } |
| |
| |
| /** |
| * Render a printable version of this Rule. |
| */ |
| public String toString() { |
| |
| StringBuffer sb = new StringBuffer("SetRootRule["); |
| sb.append("methodName="); |
| sb.append(methodName); |
| sb.append(", paramType="); |
| sb.append(paramType); |
| sb.append("]"); |
| return (sb.toString()); |
| |
| } |
| |
| |
| } |
