propertysetter.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_CONFIG_PROPERTYSETTER_H
#define _LOG4CXX_CONFIG_PROPERTYSETTER_H
 
#include <log4cxx/logstring.h>
#include <log4cxx/helpers/object.h>
 
namespace LOG4CXX_NS
{
namespace helpers
{
class Object;
LOG4CXX_PTR_DEF(Object);
}
}
 
// Instantiate template pointer type passed as parameter
LOG4CXX_INSTANTIATE_EXPORTED_PTR(LOG4CXX_NS::helpers::Object);
 
namespace LOG4CXX_NS
{
namespace helpers
{
class Properties;
class Pool;
}
 
namespace config
{
class LOG4CXX_EXPORT PropertySetter
{
    protected:
        helpers::ObjectPtr obj;
 
    public:
        PropertySetter(const helpers::ObjectPtr& obj);

        static void setProperties(const helpers::ObjectPtr& obj, helpers::Properties& properties, const LogString& prefix);

        void setProperties(helpers::Properties& properties, const LogString& prefix);

        void setProperty(const LogString& option, const LogString& value);
 
        void activate();
 
#if LOG4CXX_ABI_VERSION <= 15
        [[deprecated("Use setProperties() without a Pool parameter instead")]]
        static void setProperties(const helpers::ObjectPtr& obj, helpers::Properties& properties, const LogString& prefix, helpers::Pool& p);
        [[deprecated("Use setProperties() without a Pool parameter instead")]]
        void setProperties(helpers::Properties& properties, const LogString& prefix, helpers::Pool& p);
        [[deprecated("Use setProperty() without a Pool parameter instead")]]
        void setProperty(const LogString& option, const LogString& value, helpers::Pool& p);
        [[deprecated("Use activate() without a Pool parameter instead")]]
        void activate(helpers::Pool& p);
#endif
}; // class PropertySetter
}  // namespace config;
} // namespace log4cxx
 
#endif //_LOG4CXX_CONFIG_PROPERTYSETTER_H