optionconverter.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_HELPER_OPTION_CONVERTER_H
#define _LOG4CXX_HELPER_OPTION_CONVERTER_H
 
#include <log4cxx/logstring.h>
#include <log4cxx/spi/configurator.h>
 
namespace LOG4CXX_NS
{
class Level;
class File;
typedef std::shared_ptr<Level> LevelPtr;
 
 
namespace helpers
{
class Properties;
 
class Class;

class LOG4CXX_EXPORT OptionConverter
{
    private:
        OptionConverter() {}
 
    public:
        static LogString convertSpecialChars(const LogString& s);

        static bool toBoolean(const LogString& value, bool defaultValue);
        static int toInt(const LogString& value, int defaultValue);
        static long toFileSize(const LogString& value, long defaultValue);
        static LevelPtr toLevel(const LogString& value,
            const LevelPtr& defaultValue);

        static LogString findAndSubst(const LogString& key, Properties& props);

        static LogString substVars(const LogString& val, Properties& props);

        static LogString getSystemProperty(const LogString& key, const LogString& def);

        static ObjectPtr instantiateByClassName(const LogString& className,
            const Class& superClass, const ObjectPtr& defaultValue);
 
        static ObjectPtr instantiateByKey(Properties& props,
            const LogString& key, const Class& superClass,
            const ObjectPtr& defaultValue);

        static spi::ConfigurationStatus selectAndConfigure
            ( const File&                     configFileName
            , const LogString&                className = {}
            , const spi::LoggerRepositoryPtr& target = {}
            , int                             millisecondDelay = 0
            );
};
}  // namespace helpers
} // namespace log4cxx
 
#endif //_LOG4CXX_HELPER_OPTION_CONVERTER_H