01: /*
02:
03: Licensed to the Apache Software Foundation (ASF) under one or more
04: contributor license agreements. See the NOTICE file distributed with
05: this work for additional information regarding copyright ownership.
06: The ASF licenses this file to You under the Apache License, Version 2.0
07: (the "License"); you may not use this file except in compliance with
08: the License. You may obtain a copy of the License at
09:
10: http://www.apache.org/licenses/LICENSE-2.0
11:
12: Unless required by applicable law or agreed to in writing, software
13: distributed under the License is distributed on an "AS IS" BASIS,
14: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15: See the License for the specific language governing permissions and
16: limitations under the License.
17:
18: */
19: package org.apache.batik.i18n;
20:
21: import java.util.Locale;
22: import java.util.MissingResourceException;
23:
24: /**
25: * This interface must be implemented by the classes which must provide a
26: * way to override the default locale.
27: *
28: * @author <a href="mailto:stephane@hillion.org">Stephane Hillion</a>
29: * @version $Id: Localizable.java 475477 2006-11-15 22:44:28Z cam $
30: */
31: public interface Localizable {
32: /**
33: * Provides a way to the user to specify a locale which override the
34: * default one. If null is passed to this method, the used locale
35: * becomes the global one.
36: * @param l The locale to set.
37: */
38: void setLocale(Locale l);
39:
40: /**
41: * Returns the current locale or null if the locale currently used is
42: * the default one.
43: */
44: Locale getLocale();
45:
46: /**
47: * Creates and returns a localized message, given the key of the message
48: * in the resource bundle and the message parameters.
49: * The messages in the resource bundle must have the syntax described in
50: * the java.text.MessageFormat class documentation.
51: * @param key The key used to retreive the message from the resource
52: * bundle.
53: * @param args The objects that compose the message.
54: * @exception MissingResourceException if the key is not in the bundle.
55: */
56: String formatMessage(String key, Object[] args)
57: throws MissingResourceException;
58: }
|