org.apache.tomcat.util.digester.SetTopRule Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Portions Copyright [2019] Payara Foundation and/or affiliates
package org.apache.tomcat.util.digester;
import org.glassfish.web.util.IntrospectionUtils;
import java.util.logging.Level;
/**
* Rule implementation that calls a "set parent" method on the top (child)
* object, passing the (top-1) (parent) object as an argument.
*
* 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.
*/
public class SetTopRule extends Rule {
// ----------------------------------------------------------- Constructors
/**
* Construct a "set parent" rule with the specified method name. The
* "set parent" method's argument type is assumed to be the class of the
* parent object.
*
* @param digester The associated Digester
* @param methodName Method name of the "set parent" method to call
*
* @deprecated The digester instance is now set in the {@link Digester#addRule} method.
* Use {@link #SetTopRule(String methodName)} instead.
*/
public SetTopRule(Digester digester, String methodName) {
this(methodName);
}
/**
* Construct a "set parent" rule with the specified method name.
*
* @param digester The associated Digester
* @param methodName Method name of the "set parent" method to call
* @param paramType Java class of the "set parent" method's argument
* (if you wish to use a primitive type, specify the corresonding
* Java wrapper class instead, such as java.lang.Boolean
* for a boolean parameter)
*
* @deprecated The digester instance is now set in the {@link Digester#addRule} method.
* Use {@link #SetTopRule(String methodName, String paramType)} instead.
*/
public SetTopRule(Digester digester, String methodName,
String paramType) {
this(methodName, paramType);
}
/**
* Construct a "set parent" rule with the specified method name. The
* "set parent" method's argument type is assumed to be the class of the
* parent object.
*
* @param methodName Method name of the "set parent" method to call
*/
public SetTopRule(String methodName) {
this(methodName, null);
}
/**
* Construct a "set parent" rule with the specified method name.
*
* @param methodName Method name of the "set parent" method to call
* @param paramType Java class of the "set parent" method's argument
* (if you wish to use a primitive type, specify the corresonding
* Java wrapper class instead, such as java.lang.Boolean
* for a boolean parameter)
*/
public SetTopRule(String methodName,
String paramType) {
this.methodName = methodName;
this.paramType = paramType;
}
// ----------------------------------------------------- Instance Variables
/**
* The method name to call on the child 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
/**
* Is exact matching being used.
*
* This rule uses org.apache.commons.beanutils.MethodUtils
* to introspect the relevent objects so that the right method can be called.
* Originally, MethodUtils.invokeExactMethod 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.
*
* When exact matching is disabled, MethodUtils.invokeMethod 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.
*
* The default setting is to disable exact matches.
*
* @return true iff exact matching is enabled
* @since Digester Release 1.1.1
*/
public boolean isExactMatch() {
return useExactMatch;
}
/**
* Set whether exact matching is enabled.
*
* See {@link #isExactMatch()}.
*
* @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.
*/
@Override
public void end() throws Exception {
// Identify the objects to be used
Object child = digester.peek(0);
Object parent = digester.peek(1);
if (digester.log.isLoggable(Level.FINE)) {
if (child == null) {
digester.log.log(Level.FINE, "[SetTopRule]'{'{0}'}' Call [NULL CHILD].{1}({2})", new Object[]{digester.match, methodName, parent});
} else {
digester.log.log(Level.FINE, "[SetTopRule]'{'{0}'}' Call {1}.{2}({3})",
new Object[]{digester.match, child.getClass().getName(), methodName, parent});
}
}
// Call the specified method
IntrospectionUtils.callMethod1(child, methodName,
parent, paramType, digester.getClassLoader());
}
/**
* Render a printable version of this Rule.
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder("SetTopRule[");
sb.append("methodName=");
sb.append(methodName);
sb.append(", paramType=");
sb.append(paramType);
sb.append("]");
return (sb.toString());
}
}