triggeringpolicy.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_TRIGGER_POLICY_H)
#define _LOG4CXX_ROLLING_TRIGGER_POLICY_H


#include <log4cxx/spi/optionhandler.h>
#include <log4cxx/helpers/object.h>
#include <log4cxx/spi/loggingevent.h>
#include <log4cxx/appender.h>

namespace log4cxx
{
class File;

namespace rolling
{

class LOG4CXX_EXPORT TriggeringPolicy :
    public virtual spi::OptionHandler,
    public virtual helpers::Object
{
        DECLARE_ABSTRACT_LOG4CXX_OBJECT(TriggeringPolicy)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(TriggeringPolicy)
        LOG4CXX_CAST_ENTRY(spi::OptionHandler)
        END_LOG4CXX_CAST_MAP()
    public:
        virtual ~TriggeringPolicy();

        virtual bool isTriggeringEvent(
            Appender* appender,
            const log4cxx::spi::LoggingEventPtr& event,
            const LogString& filename,
            size_t fileLength) = 0;

};

LOG4CXX_PTR_DEF(TriggeringPolicy);


}
}

#endif