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   /*
   20    * Created on May 4, 2003
   21    */
   22   package org.apache.jmeter.engine.util;
   23   
   24   import java.util.Map;
   25   
   26   import org.apache.jmeter.functions.InvalidVariableException;
   27   import org.apache.jmeter.testelement.property.JMeterProperty;
   28   
   29   interface ValueTransformer {
   30       /**
   31        * Transform the given property and return the new version.
   32        *
   33        * @param property
   34        * @return the transformed property
   35        */
   36       public JMeterProperty transformValue(JMeterProperty property) throws InvalidVariableException;
   37   
   38       /**
   39        * Set the master function for the value transformer. This handles
   40        * converting strings to functions.
   41        *
   42        * @param masterFunction
   43        */
   44       public void setMasterFunction(CompoundVariable masterFunction);
   45   
   46       /**
   47        * Set the variable names and values used to reverse replace functions with
   48        * strings, and undo functions to raw values.
   49        *
   50        * @param vars
   51        */
   52       public void setVariables(Map vars);
   53   }