1 /*
2  * reserved comment block
3  * DO NOT REMOVE OR ALTER!
4  */
5 /*
6  * Licensed to the Apache Software Foundation (ASF) under one or more
7  * contributor license agreements.  See the NOTICE file distributed with
8  * this work for additional information regarding copyright ownership.
9  * The ASF licenses this file to You under the Apache License, Version 2.0
10  * (the "License"); you may not use this file except in compliance with
11  * the License.  You may obtain a copy of the License at
12  *
13  *      http://www.apache.org/licenses/LICENSE-2.0
14  *
15  * Unless required by applicable law or agreed to in writing, software
16  * distributed under the License is distributed on an "AS IS" BASIS,
17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18  * See the License for the specific language governing permissions and
19  * limitations under the License.
20  */
21 
22 package com.sun.org.apache.xerces.internal.util;
23 
24 import java.util.Locale;
25 import java.util.MissingResourceException;
26 
27 /**
28  * This interface provides a generic message formatting mechanism and
29  * is useful for producing messages that must be localed and/or formatted
30  * with replacement text.
31  *
32  * @see com.sun.org.apache.xerces.internal.impl.XMLErrorReporter
33  *
34  * @author Andy Clark
35  *
36  */
37 public interface MessageFormatter {
38 
39     //
40     // MessageFormatter methods
41     //
42 
43     /**
44      * Formats a message with the specified arguments using the given
45      * locale information.
46      *
47      * @param locale    The locale of the message.
48      * @param key       The message key.
49      * @param arguments The message replacement text arguments. The order
50      *                  of the arguments must match that of the placeholders
51      *                  in the actual message.
52      *
53      * @return Returns the formatted message.
54      *
55      * @throws MissingResourceException Thrown if the message with the
56      *                                  specified key cannot be found.
57      */
formatMessage(Locale locale, String key, Object[] arguments)58     public String formatMessage(Locale locale, String key, Object[] arguments)
59         throws MissingResourceException;
60 
61 } // interface MessageFormatter
62