1 /**
2 * This file Copyright (c) 2003-2014 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.cms.i18n;
35
36 import java.util.Iterator;
37 import java.util.Locale;
38
39
40 /**
41 * Storage of messages - key value pairs.
42 * @author Philipp Bracher
43 * @version $Revision$ ($Author$)
44 */
45 public interface Messages {
46
47 /**
48 * @return current locale
49 */
50 public Locale getLocale();
51
52 /**
53 * If no basename is provided this method returns DEFAULT_BASENAME.
54 * @return current basename
55 */
56 public String getBasename();
57
58 /**
59 * Get the message from the bundle.
60 * @param key the key
61 * @return message
62 */
63 public String get(String key);
64
65 /**
66 * Replace the {n} parameters in the string.
67 * @see java.text.MessageFormat#format(String, Object...)
68 */
69 public String get(String key, Object[] args);
70
71 /**
72 * You can provide a default value if the key is not found.
73 * @param key key
74 * @param defaultMsg the default message
75 * @return the message
76 */
77 public String getWithDefault(String key, String defaultMsg);
78
79 /**
80 * With default value and replacement strings.
81 * @param key key
82 * @param args replacement strings
83 * @param defaultMsg default message
84 * @return message
85 */
86 public String getWithDefault(String key, Object[] args, String defaultMsg);
87
88 /**
89 * Iterate over the keys.
90 * @return iterator
91 */
92 public Iterator<String> keys();
93
94 /**
95 * Reload the messages.
96 * @throws Exception
97 */
98 public void reload() throws Exception;
99
100 }