/*

 * 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_SPI_ROOT_LOGGER_H

#define _LOG4CXX_SPI_ROOT_LOGGER_H

#include <log4cxx/logger.h>

namespace LOG4CXX_NS

{

namespace spi

{

/**

RootLogger sits at the top of the logger hierachy. It is a

regular logger except that it provides several guarantees.

<p>First, it cannot be assigned a null

level. Second, since root logger cannot have a parent, the

#getEffectiveLevel method always returns the value of the

level field without walking the hierarchy.

*/

class LOG4CXX_EXPORT RootLogger : public Logger

{

  public:

    /**

    The root logger names itself as "root". However, the root

    logger cannot be retrieved by name.

    */

    RootLogger(const LevelPtr& level);

#if LOG4CXX_ABI_VERSION <= 15

    [[ deprecated( "Pool is no longer required" ) ]]

    RootLogger(helpers::Pool& pool, const LevelPtr level);

#endif

    ~RootLogger() {}

    /**

    Return the assigned level value without walking the logger

    hierarchy.

    */

    virtual const LevelPtr& getEffectiveLevel() const;

    /**

                Setting a null value to the level of the root logger may have catastrophic

                results. We prevent this here.

                */

    void setLevel(const LevelPtr level);

};

}  // namespace spi

} // namespace log4cxx

#endif //_LOG4CXX_SPI_ROOT_LOGGER_H