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.io.IOException;
031import java.io.InputStream;
032import java.util.Locale;
033import java.util.PropertyResourceBundle;
034import java.util.ResourceBundle;
035
036/**
037 * A property based resource bundle with increased visibility of some key methods.<p>
038 *
039 * @since 6.2.0
040 *
041 * @see org.opencms.i18n.CmsResourceBundleLoader
042 */
043public class CmsPropertyResourceBundle extends PropertyResourceBundle implements I_CmsResourceBundle {
044
045    /** The locale to use. */
046    protected Locale m_locale;
047
048    /**
049     * Default constructor from parent class.<p>
050     *
051     * @param stream property file to read from
052     *
053     * @throws IOException in case the file could not be read from
054     */
055    public CmsPropertyResourceBundle(InputStream stream)
056    throws IOException {
057
058        super(stream);
059    }
060
061    /**
062     * @see org.opencms.i18n.I_CmsResourceBundle#getClone()
063     */
064    public I_CmsResourceBundle getClone() {
065
066        // doesn't need to be cloned
067        return this;
068    }
069
070    /**
071     * @see java.util.ResourceBundle#getLocale()
072     */
073    @Override
074    public Locale getLocale() {
075
076        return m_locale;
077    }
078
079    /**
080     * @see org.opencms.i18n.I_CmsResourceBundle#setLocale(java.util.Locale)
081     */
082    public void setLocale(Locale l) {
083
084        m_locale = l;
085    }
086
087    /**
088     * @see org.opencms.i18n.I_CmsResourceBundle#setParent(java.util.ResourceBundle)
089     */
090    @Override
091    public void setParent(ResourceBundle p) {
092
093        super.setParent(p);
094    }
095}