001    // Copyright 2006 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry5.ioc;
016    
017    /**
018     * Obtained from a {@link org.apache.tapestry5.ioc.Messages}, used to format messages for a specific localized message
019     * key.
020     */
021    public interface MessageFormatter
022    {
023        /**
024         * Formats the message. The arguments are passed to {@link java.util.Formatter} as is with one exception: Object of
025         * type {@link Throwable} are converted to their {@link Throwable#getMessage()} (or, if that is null, to the name of
026         * the class).
027         *
028         * @param args
029         * @return formatted string
030         */
031        String format(Object... args);
032    }