resourcebundle.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _LOG4CXX_HELPERS_RESOURCE_BUNDLE_H
#define _LOG4CXX_HELPERS_RESOURCE_BUNDLE_H

#include <log4cxx/helpers/object.h>

namespace log4cxx
{
namespace helpers
{
class Locale;

class ResourceBundle;
LOG4CXX_PTR_DEF(ResourceBundle);

class LOG4CXX_EXPORT ResourceBundle : public Object
{
    public:
        DECLARE_ABSTRACT_LOG4CXX_OBJECT(ResourceBundle)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(ResourceBundle)
        END_LOG4CXX_CAST_MAP()

        
        virtual LogString getString(const LogString& key) const = 0;

        static ResourceBundlePtr getBundle(const LogString& baseName,
            const Locale& locale);

    protected:
        /*
        Sets the parent bundle of this bundle. The parent bundle is
        searched by #getString when this bundle does not contain a particular
        resource.

        Parameters:
        parent - this bundle's parent bundle.
        */
        inline void setParent(const ResourceBundlePtr& parent1)
        {
            this->parent = parent1;
        }

        ResourceBundlePtr parent;
}; // class ResourceBundle
}  // namespace helpers
} // namespace log4cxx

#endif