1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.util;
18
19 import org.apache.logging.log4j.message.MultiformatMessage;
20
21 /**
22 * A Message that can render itself in more than one way. The format string is used by the
23 * Message implementation as extra information that it may use to help it to determine how
24 * to format itself. For example, MapMessage accepts a format of "XML" to tell it to render
25 * the Map as XML instead of its default format of {key1="value1" key2="value2"}.
26 *
27 * @since 2.10
28 */
29 public interface MultiFormatStringBuilderFormattable extends MultiformatMessage, StringBuilderFormattable {
30
31 /**
32 * Writes a text representation of this object into the specified {@code StringBuilder}, ideally without allocating
33 * temporary objects.
34 *
35 * @param formats An array of Strings that provide extra information about how to format the message.
36 * Each MultiFormatStringBuilderFormattable implementation is free to use the provided formats however they choose.
37 * @param buffer the StringBuilder to write into
38 */
39 void formatTo(String[] formats, StringBuilder buffer);
40
41 }