001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.commons.logging;
018
019import org.apache.juneau.commons.utils.StringUtils;
020
021/**
022 * Strategy interface for rendering log message patterns.
023 */
024@FunctionalInterface
025public interface MessageGenerator {
026
027   /**
028    * Printf-style message generator backed by {@link #format(String, Object...)}.
029    */
030   MessageGenerator PRINTF = StringUtils::format;
031
032   /**
033    * MessageFormat-style message generator backed by {@link StringUtils#mformat(String, Object...)}.
034    */
035   MessageGenerator MESSAGE_FORMAT = StringUtils::mformat;
036
037   /**
038    * Renders a message pattern with arguments.
039    *
040    * @param pattern The message pattern.
041    * @param args The message arguments.
042    * @return The rendered message.
043    */
044   String format(String pattern, Object...args);
045}