org.opensearch.common.util.NamedFormatter Maven / Gradle / Ivy

Go to download
/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 */

/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch 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.
 */

/*
 * Modifications Copyright OpenSearch Contributors. See
 * GitHub history for details.
 */

package org.opensearch.common.util;

import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * A formatter that allows named placeholders e.g. "%(param)" to be replaced.
 */
public class NamedFormatter {
    private static final Pattern PARAM_REGEX = Pattern.compile(
        // Match either any backlash-escaped characters, or a "%(param)" pattern.
        // COMMENTS is specified to allow whitespace in this pattern, for clarity
        "\\\\(.) | (% \\( ([^)]+) \\) )",
        Pattern.COMMENTS
    );

    private NamedFormatter() {}

    /**
     * Replaces named parameters of the form %(param) in format strings. For example:
     *
     * 
     * NamedFormatter.format("Hello, %(name)!", Map.of("name", "world")) → "Hello, world!"
     * NamedFormatter.format("Hello, \%(name)!", Map.of("name", "world")) → "Hello, %(world)!"
     * NamedFormatter.format("Hello, %(oops)!", Map.of("name", "world")) → {@link IllegalArgumentException}
     * 
     *
     * @param fmt The format string. Any %(param) is replaced by its corresponding value in the values map.
     *             Parameter patterns can be escaped by prefixing with a backslash.
     * @param values a map of parameter names to values.
     * @return The formatted string.
     * @throws IllegalArgumentException if a parameter is found in the format string with no corresponding value
     */
    public static String format(String fmt, Map values) {
        final Matcher matcher = PARAM_REGEX.matcher(fmt);

        boolean result = matcher.find();
        if (result) {
            final StringBuffer sb = new StringBuffer();
            do {
                String replacement;

                // Escaped characters are unchanged
                if (matcher.group(1) != null) {
                    replacement = matcher.group(1);
                } else {
                    final String paramName = matcher.group(3);
                    if (values.containsKey(paramName) == true) {
                        replacement = values.get(paramName).toString();
                    } else {
                        throw new IllegalArgumentException("No parameter value for %(" + paramName + ")");
                    }
                }

                matcher.appendReplacement(sb, replacement);
                result = matcher.find();
            } while (result);

            matcher.appendTail(sb);
            return sb.toString();
        }

        return fmt;
    }
}