All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.tomcat.util.digester.CallParamRule Maven / Gradle / Ivy

There is a newer version: 4.1.2.181
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 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.
 */

package org.apache.tomcat.util.digester;


import org.xml.sax.Attributes;

import java.util.logging.Level;


/**
 * 

Rule implementation that saves a parameter for use by a surrounding * CallMethodRule.

* *

This parameter may be: *

    *
  • from an attribute of the current element * See {@link #CallParamRule(int paramIndex, String attributeName)} *
  • from current the element body * See {@link #CallParamRule(int paramIndex)} *
  • from the top object on the stack. * See {@link #CallParamRule(int paramIndex, boolean fromStack)} *
  • the current path being processed (separate Rule). * See {@link PathCallParamRule} *
*

*/ public class CallParamRule extends Rule { // ----------------------------------------------------------- Constructors /** * Construct a "call parameter" rule that will save the body text of this * element as the parameter value. * * @param digester The associated Digester * @param paramIndex The zero-relative parameter number * * @deprecated The digester instance is now set in the {@link Digester#addRule} method. * Use {@link #CallParamRule(int paramIndex)} instead. */ public CallParamRule(Digester digester, int paramIndex) { this(paramIndex); } /** * Construct a "call parameter" rule that will save the value of the * specified attribute as the parameter value. * * @param digester The associated Digester * @param paramIndex The zero-relative parameter number * @param attributeName The name of the attribute to save * * @deprecated The digester instance is now set in the {@link Digester#addRule} method. * Use {@link #CallParamRule(int paramIndex, String attributeName)} instead. */ public CallParamRule(Digester digester, int paramIndex, String attributeName) { this(paramIndex, attributeName); } /** * Construct a "call parameter" rule that will save the body text of this * element as the parameter value. * * @param paramIndex The zero-relative parameter number */ public CallParamRule(int paramIndex) { this(paramIndex, null); } /** * Construct a "call parameter" rule that will save the value of the * specified attribute as the parameter value. * * @param paramIndex The zero-relative parameter number * @param attributeName The name of the attribute to save */ public CallParamRule(int paramIndex, String attributeName) { this.paramIndex = paramIndex; this.attributeName = attributeName; } /** * Construct a "call parameter" rule. * * @param paramIndex The zero-relative parameter number * @param fromStack should this parameter be taken from the top of the stack? */ public CallParamRule(int paramIndex, boolean fromStack) { this.paramIndex = paramIndex; this.fromStack = fromStack; } /** * Constructs a "call parameter" rule which sets a parameter from the stack. * If the stack contains too few objects, then the parameter will be set to null. * * @param paramIndex The zero-relative parameter number * @param stackIndex the index of the object which will be passed as a parameter. * The zeroth object is the top of the stack, 1 is the next object down and so on. */ public CallParamRule(int paramIndex, int stackIndex) { this.paramIndex = paramIndex; this.fromStack = true; this.stackIndex = stackIndex; } // ----------------------------------------------------- Instance Variables /** * The attribute from which to save the parameter value */ protected String attributeName = null; /** * The zero-relative index of the parameter we are saving. */ protected int paramIndex = 0; /** * Is the parameter to be set from the stack? */ protected boolean fromStack = false; /** * The position of the object from the top of the stack */ protected int stackIndex = 0; /** * Stack is used to allow nested body text to be processed. * Lazy creation. */ protected ArrayStack bodyTextStack; // --------------------------------------------------------- Public Methods /** * Process the start of this element. * * @param attributes The attribute list for this element */ public void begin(Attributes attributes) throws Exception { Object param = null; if (attributeName != null) { param = attributes.getValue(attributeName); } else if(fromStack) { param = digester.peek(stackIndex); if (digester.log.isLoggable(Level.FINE)) { StringBuilder sb = new StringBuilder("[CallParamRule]{"); sb.append(digester.match); sb.append("} Save from stack; from stack?").append(fromStack); sb.append("; object=").append(param); digester.log.fine(sb.toString()); } } // Have to save the param object to the param stack frame here. // Can't wait until end(). Otherwise, the object will be lost. // We can't save the object as instance variables, as // the instance variables will be overwritten // if this CallParamRule is reused in subsequent nesting. if(param != null) { Object parameters[] = (Object[]) digester.peekParams(); parameters[paramIndex] = param; } } /** * Process the body text of this element. * * @param bodyText The body text of this element */ public void body(String bodyText) throws Exception { if (attributeName == null && !fromStack) { // We must wait to set the parameter until end // so that we can make sure that the right set of parameters // is at the top of the stack if (bodyTextStack == null) { bodyTextStack = new ArrayStack(); } bodyTextStack.push(bodyText.trim()); } } /** * Process any body texts now. */ public void end(String namespace, String name) { if (bodyTextStack != null && !bodyTextStack.empty()) { // what we do now is push one parameter onto the top set of parameters Object parameters[] = (Object[]) digester.peekParams(); parameters[paramIndex] = bodyTextStack.pop(); } } /** * Render a printable version of this Rule. */ public String toString() { StringBuilder sb = new StringBuilder("CallParamRule["); sb.append("paramIndex="); sb.append(paramIndex); sb.append(", attributeName="); sb.append(attributeName); sb.append(", from stack="); sb.append(fromStack); sb.append("]"); return (sb.toString()); } }