formattinginfo.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_HELPER_FORMATTING_INFO_H
#define _LOG4CXX_HELPER_FORMATTING_INFO_H
 
 
#include <log4cxx/helpers/object.h>
#include <log4cxx/logstring.h>
 
namespace LOG4CXX_NS
{
namespace pattern
{
 
 
class FormattingInfo;
typedef std::shared_ptr<FormattingInfo> FormattingInfoPtr;
 
 
class LOG4CXX_EXPORT FormattingInfo : public virtual LOG4CXX_NS::helpers::Object
{
        LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(FormattingInfoPrivate, m_priv)
 
    public:
        DECLARE_ABSTRACT_LOG4CXX_OBJECT(FormattingInfo)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(FormattingInfo)
        END_LOG4CXX_CAST_MAP()
 
 
        
        FormattingInfo(
            const bool leftAlign, const int minLength, const int maxLength);
        ~FormattingInfo();
 
        static FormattingInfoPtr getDefault();
 
        bool isLeftAligned() const;
 
        int getMinLength() const;
 
        int getMaxLength() const;
 
#if LOG4CXX_ABI_VERSION <= 15
        [[ deprecated( "Use adjustField() instead" ) ]]
        void format(const int fieldStart, LogString& buffer) const;
#endif
        void adjustField(const LogString::size_type fieldStart, LogString& buffer) const;
};
LOG4CXX_PTR_DEF(FormattingInfo);
}
}
 
 
#endif