fixedwindowrollingpolicy.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_FIXED_WINDOW_ROLLING_POLICY_H)
#define _LOG4CXX_ROLLING_FIXED_WINDOW_ROLLING_POLICY_H

#include <log4cxx/rolling/rollingpolicybase.h>




namespace log4cxx
{

namespace helpers
{
class Pool;
}

namespace rolling
{


class LOG4CXX_EXPORT FixedWindowRollingPolicy : public RollingPolicyBase
{
        DECLARE_LOG4CXX_OBJECT(FixedWindowRollingPolicy)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(FixedWindowRollingPolicy)
        LOG4CXX_CAST_ENTRY_CHAIN(RollingPolicyBase)
        END_LOG4CXX_CAST_MAP()

        int minIndex;
        int maxIndex;
        bool explicitActiveFile;

        enum { MAX_WINDOW_SIZE = 12 };

        bool purge(int purgeStart, int maxIndex, log4cxx::helpers::Pool& p) const;

    public:

        FixedWindowRollingPolicy();

        void activateOptions(log4cxx::helpers::Pool& p);
        void setOption(const LogString& option,
            const LogString& value);

        void rollover();

        int getMaxIndex() const;

        int getMinIndex() const;

        void setMaxIndex(int newVal);
        void setMinIndex(int newVal);

        RolloverDescriptionPtr initialize(
            const   LogString&              currentActiveFile,
            const   bool                    append,
            log4cxx::helpers::Pool& pool);

        RolloverDescriptionPtr rollover(
            const   LogString&              currentActiveFile,
            const   bool                    append,
            log4cxx::helpers::Pool& pool);

    protected:
        log4cxx::pattern::PatternMap getFormatSpecifiers() const;

};

LOG4CXX_PTR_DEF(FixedWindowRollingPolicy);

}
}

#endif