/*
 * 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.logging.log4j.message;

/**
 * A Message that can have a format String attached to it.
 */
public interface FormattedMessage extends Message {
    /**
     * Set the message format.
     * @param format The message format.
     */
    void setFormat(String format);

    /**
     * Return the message format.
     * @return the message format String.
     */
    String getFormat();
}

@@ -899,16 +899,314 @@
 d to it.
+ The format string is used by the%0A * Message implementation as extra information that it may use to help it to determine how%0A * to format itself. For example, MapMessage accepts a format of %22XML%22 to tell it to render%0A * the Map as XML instead of its default format of %7Bkey1=%22value1%22 key2=%22value2%22%7D.
 %0A */%0Apub

Add more details to the javadoc