rollingpolicy.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.
 */
 
#if !defined(_LOG4CXX_ROLLING_ROLLING_POLICY_H)
#define _LOG4CXX_ROLLING_ROLLING_POLICY_H
 
#include <log4cxx/spi/optionhandler.h>
#include <log4cxx/rolling/rolloverdescription.h>
#include <log4cxx/file.h>
 
namespace LOG4CXX_NS
{
namespace rolling
{
 

class LOG4CXX_EXPORT RollingPolicy :
    public virtual spi::OptionHandler
{
        DECLARE_ABSTRACT_LOG4CXX_OBJECT(RollingPolicy)
 
    public:
        virtual ~RollingPolicy() {}

#if LOG4CXX_ABI_VERSION <= 15
        RolloverDescriptionPtr initialize(const LogString& currentActiveFile, bool append);
        virtual RolloverDescriptionPtr initialize(
            const   LogString&              currentActiveFile,
            const   bool                    append,
            LOG4CXX_NS::helpers::Pool& pool) = 0;
#define LOG4CXX_ROLLING_POLICY_INITIALIZE_FORMAL_PARAMETERS const LogString& currentActiveFile, bool append, helpers::Pool& p
#else
        virtual RolloverDescriptionPtr initialize(const LogString& currentActiveFile, bool append) = 0;
#define LOG4CXX_ROLLING_POLICY_INITIALIZE_FORMAL_PARAMETERS const LogString& currentActiveFile, bool append
        [[deprecated("Use initialize() without a Pool parameter instead")]]
        RolloverDescriptionPtr initialize(const LogString& currentActiveFile, bool append, helpers::Pool& pool);
#endif

#if LOG4CXX_ABI_VERSION <= 15
        RolloverDescriptionPtr rollover(const LogString& currentActiveFile, bool append);
        virtual RolloverDescriptionPtr rollover(
            const   LogString&              currentActiveFile,
            const   bool                    append,
            LOG4CXX_NS::helpers::Pool& pool) = 0;
#define LOG4CXX_ROLLING_POLICY_ROLLOVER_FORMAL_PARAMETERS const LogString& currentActiveFile, bool append, helpers::Pool& p
#else
        virtual RolloverDescriptionPtr rollover(const LogString& currentActiveFile, bool append) = 0;
#define LOG4CXX_ROLLING_POLICY_ROLLOVER_FORMAL_PARAMETERS const LogString& currentActiveFile, bool append
        [[deprecated("Use rollover() without a Pool parameter instead")]]
        RolloverDescriptionPtr rollover(const LogString& currentActiveFile, bool append, helpers::Pool& pool);
#endif
};
 
LOG4CXX_PTR_DEF(RollingPolicy);
 
}
}
#endif