001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (C) Alkacon Software (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;
031
032/**
033 * Data class containing the parameters for a VFS-based resource bundle.<p>
034 */
035public class CmsVfsBundleParameters {
036
037    /** The base path in the VFS. */
038    private String m_basePath;
039
040    /** True if this is the set of parameters for the default message bundle. */
041    private boolean m_isDefault;
042
043    /** The locale of the message bundle. */
044    private Locale m_locale;
045
046    /** The name of the message bundle. */
047    private String m_name;
048
049    /** A string constant indicating the type of the VFS bundle. */
050    private String m_type;
051
052    /**
053     *
054     * @param name the name of the message bundle
055     * @param basePath the root base path of the message bundle
056     * @param locale the locale of the message bundle
057     * @param isDefault true if this is the set of parameters for the default locale
058     * @param type a string constant indicating the type of the resource bundle
059     */
060    public CmsVfsBundleParameters(String name, String basePath, Locale locale, boolean isDefault, String type) {
061
062        m_name = name;
063        m_basePath = basePath;
064        m_locale = locale;
065        m_isDefault = isDefault;
066        m_type = type;
067    }
068
069    /**
070     * Gets the base path of the resource bundle.<p>
071     *
072     * @return the base path of the resource bundle
073     */
074    public String getBasePath() {
075
076        return m_basePath;
077    }
078
079    /**
080     * Gets the locale.<p>
081     *
082     * @return the locale
083     */
084    public Locale getLocale() {
085
086        return m_locale;
087    }
088
089    /**
090     * Gets the name of the message bundle.<p>
091     *
092     * @return the name of the message bundle
093     */
094    public String getName() {
095
096        return m_name;
097    }
098
099    /**
100     * Gets the resource bundle type.<p>
101     *
102     * @return the resource bundle type
103     */
104    public String getType() {
105
106        return m_type;
107    }
108
109    /**
110     * Returns true if this is the set of parameters for the default message bundle.<p>
111     *
112     * @return true if this is the set of parameters for the default message bundle
113     */
114    public boolean isDefault() {
115
116        return m_isDefault;
117    }
118
119}