MessageInterpolator.java

/*
 * 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.deltaspike.core.api.message;

import java.io.Serializable;
import java.util.Locale;

import org.apache.deltaspike.core.api.config.DeltaSpikeConfig;

/**
 * Implementations are responsible to replace placeholders in a message with the final value.
 *
 * <p>
 * An application can provide a custom implementation as @Alternative.</p>
 *
 * <p>
 * A simple implementation which uses the {@link String#format(java.util.Locale, String, Object...)} will be used by
 * default.</p>
 */
public interface MessageInterpolator extends Serializable, DeltaSpikeConfig
{
    /**
     * Replaces the arguments of the given message with the given arguments.
     *
     * @param messageText the message text which has to be interpolated
     * @param arguments   a list of numbered and/or named arguments for the current message
     * @param locale      to use for the formatting
     *
     * @return the final (interpolated) message text if it was possible to replace the parameters with the given
     *         arguments, or the unmodified messageText otherwise
     */
    String interpolate(String messageText, Serializable[] arguments, Locale locale);
}