/*

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

#define _LOG4CXX_HELPERS_APPENDER_ATTACHABLE_IMPL_H

#include <log4cxx/spi/appenderattachable.h>

#include <log4cxx/helpers/pool.h>

#include <log4cxx/log4cxx.h>

namespace LOG4CXX_NS

{

namespace spi

{

class LoggingEvent;

typedef std::shared_ptr<LoggingEvent> LoggingEventPtr;

}

namespace helpers

{

class LOG4CXX_EXPORT AppenderAttachableImpl :

  public virtual spi::AppenderAttachable

{

  protected:

    AppenderList& appenderList();

  public:

    /**

     *   Create new instance.

     */

    AppenderAttachableImpl();

#if LOG4CXX_ABI_VERSION <= 15

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

    AppenderAttachableImpl(Pool& pool);

#endif

    ~AppenderAttachableImpl();

    DECLARE_ABSTRACT_LOG4CXX_OBJECT(AppenderAttachableImpl)

    BEGIN_LOG4CXX_CAST_MAP()

    LOG4CXX_CAST_ENTRY(AppenderAttachableImpl)

    LOG4CXX_CAST_ENTRY(spi::AppenderAttachable)

    END_LOG4CXX_CAST_MAP()

    // Methods

    /**

     * Add an appender.

     */

    void addAppender(const AppenderPtr newAppender) override;

#if LOG4CXX_ABI_VERSION <= 15

    /**

     Call the <code>doAppend</code> method on all attached appenders.

    @deprecated This function is deprecated and will be removed in a future version.

    */

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

    int appendLoopOnAppenders(const spi::LoggingEventPtr& event,

      LOG4CXX_NS::helpers::Pool& p);

#endif

    /**

     Send \c event to all attached appenders.

    */

    int appendLoopOnAppenders(const spi::LoggingEventPtr& event);

    /**

     * Get all previously added appenders as an Enumeration.

     */

    AppenderList getAllAppenders() const override;

    /**

     * Get an appender by name.

     */

    AppenderPtr getAppender(const LogString& name) const override;

    /**

     Returns <code>true</code> if the specified appender is in the

     list of attached appenders, <code>false</code> otherwise.

    */

    bool isAttached(const AppenderPtr appender) const override;

    /**

     * Remove all previously added appenders.

     */

    void removeAllAppenders() override;

    /**

     * Remove the appender passed as parameter from the list of appenders.

     */

    void removeAppender(const AppenderPtr appender) override;

    /**

     * Remove the appender with the name passed as parameter from the

     * list of appenders.

     */

    void removeAppender(const LogString& name) override;

    /**

     * Replace \c oldAppender  with \c newAppender.

     * @return true if oldAppender was replaced with newAppender.

     */

    bool replaceAppender(const AppenderPtr& oldAppender, const AppenderPtr& newAppender) LOG4CXX_16_VIRTUAL_SPECIFIER;

    /**

     * Replace any previously added appenders with \c newList.

     */

    void replaceAppenders(const AppenderList& newList) LOG4CXX_16_VIRTUAL_SPECIFIER;

  private:

    LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(priv_data, m_priv)

    AppenderAttachableImpl(const AppenderAttachableImpl&);

    AppenderAttachableImpl& operator=(const AppenderAttachableImpl&);

};

LOG4CXX_PTR_DEF(AppenderAttachableImpl);

}

}

#endif //_LOG4CXX_HELPERS_APPENDER_ATTACHABLE_IMPL_H