Save This Page
Home » jakarta-jmeter-2.3.4_src » org.apache.jmeter.functions » [javadoc | source]
    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *   http://www.apache.org/licenses/LICENSE-2.0
   10    *
   11    * Unless required by applicable law or agreed to in writing, software
   12    * distributed under the License is distributed on an "AS IS" BASIS,
   13    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   14    * See the License for the specific language governing permissions and
   15    * limitations under the License.
   16    *
   17    */
   18   
   19   package org.apache.jmeter.functions;
   20   
   21   
   22   import java.util.Collection;
   23   import java.util.LinkedList;
   24   import java.util.List;
   25   
   26   import org.apache.jmeter.engine.util.CompoundVariable;
   27   import org.apache.jmeter.samplers.SampleResult;
   28   import org.apache.jmeter.samplers.Sampler;
   29   import org.apache.jmeter.util.JMeterUtils;
   30   
   31   /**
   32    * Function to get a JMeter Variable
   33    *
   34    * Parameters:
   35    * - variable name
   36    *
   37    * Returns:
   38    * - the variable value, but if not found
   39    * - the variable name itself
   40    *
   41    */
   42   public class Variable extends AbstractFunction {
   43   
   44       private static final List desc = new LinkedList();
   45   
   46       private static final String KEY = "__V"; //$NON-NLS-1$
   47   
   48       // Number of parameters expected - used to reject invalid calls
   49       private static final int MIN_PARAMETER_COUNT = 1;
   50       private static final int MAX_PARAMETER_COUNT = 1;
   51   
   52       static {
   53           desc.add(JMeterUtils.getResString("variable_name_param")); //$NON-NLS-1$
   54       }
   55   
   56       private Object[] values;
   57   
   58       public Variable() {
   59       }
   60   
   61       public synchronized String execute(SampleResult previousResult, Sampler currentSampler)
   62               throws InvalidVariableException {
   63           String variableName = ((CompoundVariable) values[0]).execute();
   64           String variableValue = getVariables().get(variableName);
   65           return variableValue == null? variableName : variableValue;
   66   
   67       }
   68   
   69       public synchronized void setParameters(Collection parameters) throws InvalidVariableException {
   70           checkParameterCount(parameters, MIN_PARAMETER_COUNT, MAX_PARAMETER_COUNT);
   71           values = parameters.toArray();
   72       }
   73   
   74       public String getReferenceKey() {
   75           return KEY;
   76       }
   77   
   78       public List getArgumentDesc() {
   79           return desc;
   80       }
   81   
   82   }

Save This Page
Home » jakarta-jmeter-2.3.4_src » org.apache.jmeter.functions » [javadoc | source]