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.logging.log4j.message;
018
019/**
020 * A Message that can render itself in more than one way. The format string is used by the
021 * Message implementation as extra information that it may use to help it to determine how
022 * to format itself. For example, MapMessage accepts a format of "XML" to tell it to render
023 * the Map as XML instead of its default format of {key1="value1" key2="value2"}.
024 */
025public interface MultiformatMessage extends Message {
026
027    /**
028     * Returns the Message formatted as a String.
029     *
030     * @param formats An array of Strings that provide extra information about how to format the message.
031     * Each MultiformatMessage implementation is free to use the provided formats however they choose.
032     *
033     * @return The message String.
034     */
035    String getFormattedMessage(String[] formats);
036
037    /**
038     * Returns the supported formats.
039     * @return The supported formats.
040     */
041    String[] getFormats();
042}