01: /*
02:
03: ============================================================================
04: The Apache Software License, Version 1.1
05: ============================================================================
06:
07: Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
08:
09: Redistribution and use in source and binary forms, with or without modifica-
10: tion, are permitted provided that the following conditions are met:
11:
12: 1. Redistributions of source code must retain the above copyright notice,
13: this list of conditions and the following disclaimer.
14:
15: 2. Redistributions in binary form must reproduce the above copyright notice,
16: this list of conditions and the following disclaimer in the documentation
17: and/or other materials provided with the distribution.
18:
19: 3. The end-user documentation included with the redistribution, if any, must
20: include the following acknowledgment: "This product includes software
21: developed by the Apache Software Foundation (http://www.apache.org/)."
22: Alternately, this acknowledgment may appear in the software itself, if
23: and wherever such third-party acknowledgments normally appear.
24:
25: 4. The names "Batik" and "Apache Software Foundation" must not be
26: used to endorse or promote products derived from this software without
27: prior written permission. For written permission, please contact
28: apache@apache.org.
29:
30: 5. Products derived from this software may not be called "Apache", nor may
31: "Apache" appear in their name, without prior written permission of the
32: Apache Software Foundation.
33:
34: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35: INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36: FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37: APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39: DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40: OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41: ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42: (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43: THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44:
45: This software consists of voluntary contributions made by many individuals
46: on behalf of the Apache Software Foundation. For more information on the
47: Apache Software Foundation, please see <http://www.apache.org/>.
48:
49: */
50:
51: package org.apache.batik.i18n;
52:
53: import java.util.Locale;
54: import java.util.MissingResourceException;
55:
56: /**
57: * This interface must be implemented by the classes which must provide a
58: * way to override the default locale.
59: *
60: * @author <a href="mailto:stephane@hillion.org">Stephane Hillion</a>
61: * @version $Id$
62: */
63: public interface Localizable {
64: /**
65: * Provides a way to the user to specify a locale which override the
66: * default one. If null is passed to this method, the used locale
67: * becomes the global one.
68: * @param l The locale to set.
69: */
70: void setLocale(Locale l);
71:
72: /**
73: * Returns the current locale or null if the locale currently used is
74: * the default one.
75: */
76: Locale getLocale();
77:
78: /**
79: * Creates and returns a localized message, given the key of the message
80: * in the resource bundle and the message parameters.
81: * The messages in the resource bundle must have the syntax described in
82: * the java.text.MessageFormat class documentation.
83: * @param key The key used to retreive the message from the resource
84: * bundle.
85: * @param args The objects that compose the message.
86: * @exception MissingResourceException if the key is not in the bundle.
87: */
88: String formatMessage(String key, Object[] args)
89: throws MissingResourceException;
90: }
|