cacheddateformat.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.
 */
 
#ifndef _LOG4CXX_HELPERS_CACHED_DATE_FORMAT_H
#define _LOG4CXX_HELPERS_CACHED_DATE_FORMAT_H
 
#include <log4cxx/helpers/dateformat.h>
 
namespace LOG4CXX_NS
{
namespace pattern
{
class LOG4CXX_EXPORT CachedDateFormat : public helpers::DateFormat
{
    public:
        enum
        {
            /*
             *  Constant used to represent that there was no change
             *  observed when changing the millisecond count.
             */
            NO_MILLISECONDS = -2,
            /*
             *  Constant used to represent that there was an
             *  observed change, but was an expected change.
             */
            UNRECOGNIZED_MILLISECONDS = -1
        };
 
    private:
        static const logchar digits[];
 
 
        static const int magic1;
 
 
        static const logchar magicString1[];
 
 
        static const int magic2;
 
 
        static const logchar magicString2[];
 
 
        static const logchar zeroString[];
 
        LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(CachedDateFormatPriv, m_priv)
 
    public:
        CachedDateFormat(const helpers::DateFormatPtr& dateFormat, int expiration);
        ~CachedDateFormat();
 
        static int findMillisecondStart(
            log4cxx_time_t time, const LogString& formatted,
            const helpers::DateFormatPtr& formatter);
#if LOG4CXX_ABI_VERSION <= 15
        [[deprecated("Use findMillisecondStart() without a Pool parameter instead")]]
        static int findMillisecondStart(
            log4cxx_time_t time, const LogString& formatted,
            const LOG4CXX_NS::helpers::DateFormatPtr& formatter,
            LOG4CXX_NS::helpers::Pool& pool);
#endif
        using DateFormat::format;
        void format( LOG4CXX_FORMAT_TIME_FORMAL_PARAMETERS ) const override;
 
    private:
        static void millisecondFormat(int millis,
            LogString& buf,
            int offset);
 
 
    public:
        void setTimeZone(const helpers::TimeZonePtr& zone) override;
 
        void numberFormat( LOG4CXX_FORMAT_NUMBER_FORMAL_PARAMETERS ) const override;
 
        static int getMaximumCacheValidity(const LogString& pattern);
 
    private:
        CachedDateFormat(const CachedDateFormat&);
        CachedDateFormat& operator=(const CachedDateFormat&);
 
        static bool regionMatches(
            const LogString& target,
            size_t toffset,
            const LogString& other,
            size_t ooffset,
            size_t len);
 
};
 
 
 
}  // namespace helpers
} // namespace log4cxx
 
#endif // _LOG4CXX_HELPERS_SIMPLE_DATE_FORMAT_H