diff --git a/scm-core/src/main/java/sonia/scm/i18n/Bundle.java b/scm-core/src/main/java/sonia/scm/i18n/Bundle.java new file mode 100644 index 0000000000..bdf3487ef2 --- /dev/null +++ b/scm-core/src/main/java/sonia/scm/i18n/Bundle.java @@ -0,0 +1,140 @@ +/** + * Copyright (c) 2010, Sebastian Sdorra All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. 2. Redistributions in + * binary form must reproduce the above copyright notice, this list of + * conditions and the following disclaimer in the documentation and/or other + * materials provided with the distribution. 3. Neither the name of SCM-Manager; + * nor the names of its contributors may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR + * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * http://bitbucket.org/sdorra/scm-manager + * + */ + + + +package sonia.scm.i18n; + +//~--- non-JDK imports -------------------------------------------------------- + +import sonia.scm.util.Util; + +//~--- JDK imports ------------------------------------------------------------ + +import java.text.MessageFormat; + +import java.util.Locale; +import java.util.ResourceBundle; + +/** + * This class is a wrapper for {@link ResourceBundle}, it applies some missing + * format options missing in {@link ResourceBundle}. + * + * @author Sebastian Sdorra + * @since 1.15 + */ +public class Bundle +{ + + /** Field description */ + private static final String SEPARATOR = System.getProperty("line.separator"); + + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + * + * @param bundle + */ + private Bundle(ResourceBundle bundle) + { + this.bundle = bundle; + } + + //~--- get methods ---------------------------------------------------------- + + /** + * Creates a new bundle instance + * + * + * @param path path to the properties file + * + * @return new bundle instance + */ + public static Bundle getBundle(String path) + { + return new Bundle(ResourceBundle.getBundle(path)); + } + + /** + * Creates a new bundle instance + * + * + * @param path path to the properties file + * @param locale locale for the properties file + * + * @return new bundle instance + */ + public static Bundle getBundle(String path, Locale locale) + { + return new Bundle(ResourceBundle.getBundle(path, locale)); + } + + /** + * This method returns the same value as + * {@link #getString(java.lang.String, java.lang.Object[])} + * with a line separator at the end. + * + * @param key key in the properties file + * @param args format arguments + * + * @return formated message + */ + public String getLine(String key, Object... args) + { + return getString(key, args).concat(SEPARATOR); + } + + /** + * Returns the value of the key, formatted with {@link MessageFormat} + * + * + * @param key key in the properties file + * @param args format arguments + * + * @return formated message + */ + public String getString(String key, Object... args) + { + String msg = bundle.getString(key); + + if (Util.isNotEmpty(args)) + { + msg = MessageFormat.format(key, args); + } + + return msg; + } + + //~--- fields --------------------------------------------------------------- + + /** Field description */ + private ResourceBundle bundle; +}