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