/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you 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.jmeter.engine.util;

import java.util.Map;

import org.apache.jmeter.functions.InvalidVariableException;
import org.apache.jmeter.testelement.property.JMeterProperty;
import org.apiguardian.api.API;

/**
 * @deprecated use {@link PropertyTransformer} instead
 */
@Deprecated
@API(status = API.Status.DEPRECATED, since = "5.6")
interface ValueTransformer extends PropertyTransformer {
    @Override
    default JMeterProperty transform(JMeterProperty input) {
        try {
            return transformValue(input);
        } catch (InvalidVariableException e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * Transform the given property and return the new version.
     *
     * @param property
     *            Property to be transformed
     * @return the transformed property
     * @throws InvalidVariableException
     *             if something went wrong while computing variables or
     *             functions
     */
    JMeterProperty transformValue(JMeterProperty property) throws InvalidVariableException;

    /**
     * Set the master function for the value transformer. This handles
     * converting strings to functions.
     *
     * @param masterFunction Function to be used for the transformation
     */
    void setMasterFunction(CompoundVariable masterFunction);

    /**
     * Set the variable names and values used to reverse replace functions with
     * strings, and undo functions to raw values.
     *
     * @param vars Map of names and values to be used for the transformation
     */
    void setVariables(Map<String, String> vars);
}
