graphql.validation.interpolation.MessageInterpolator Maven / Gradle / Ivy

Go to download
package graphql.validation.interpolation;

import graphql.GraphQLError;
import graphql.PublicSpi;
import graphql.validation.rules.ValidationEnvironment;

import java.util.Map;

/**
 * This is responsible for taking an message template and parameters
 * and turning it into a {@link graphql.GraphQLError}.
 * 
 * Remember error messages are allow to use Java EL expressions, like 
{@code ${formatter.format('%1$.2f', validatedValue)}} to build
 * more powerful error messages.
 */
@PublicSpi
public interface MessageInterpolator {
    /**
     * Called to interpolate a message template and arguments into a {@link graphql.GraphQLError}
     *
     * @param messageTemplate       the message template
     * @param messageParams         the parameters to this error
     * @param validationEnvironment the validation environment
     * @return a {@link graphql.GraphQLError}
     */
    GraphQLError interpolate(String messageTemplate, Map messageParams, ValidationEnvironment validationEnvironment);
}