001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.i18n;
029
030import java.util.Locale;
031import java.util.ResourceBundle;
032
033/**
034 * Increases the visibility of some key methods of a {@link ResourceBundle}.<p>
035 *
036 * This interface is required because the methods {@link #setParent(ResourceBundle)} and
037 * {@link #setLocale(Locale)} are not visible in the standard implementation. However,
038 * access to these methods is required by the {@link org.opencms.i18n.CmsResourceBundleLoader}.<p>
039 *
040 * @since 8.0.1
041 *
042 * @see org.opencms.i18n.CmsResourceBundleLoader
043 */
044public interface I_CmsResourceBundle {
045
046    /**
047     * Creates a clone of the resource bundle.<p>
048     *
049     * (This may not actually clone the resource bundle if it is immutable).
050     *
051     * @return a clone of the resource bundle
052     */
053    I_CmsResourceBundle getClone();
054
055    /**
056     * Sets the locale used for this resource bundle.<p>
057     *
058     * @param l the locale to set
059     */
060    void setLocale(Locale l);
061
062    /**
063     * Sets the parent bundle.<p>
064     *
065     * @param parent the parent bundle to set
066     */
067    void setParent(ResourceBundle parent);
068}