Apache Log4cxx  Version 1.3.1
formattinginfo.h
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef _LOG4CXX_HELPER_FORMATTING_INFO_H
19 #define _LOG4CXX_HELPER_FORMATTING_INFO_H
20 
21 
22 #include <log4cxx/helpers/object.h>
23 #include <log4cxx/logstring.h>
24 
25 namespace LOG4CXX_NS
26 {
27 namespace pattern
28 {
29 
30 
31 class FormattingInfo;
32 typedef std::shared_ptr<FormattingInfo> FormattingInfoPtr;
33 
34 
43 class LOG4CXX_EXPORT FormattingInfo : public virtual LOG4CXX_NS::helpers::Object
44 {
45  LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(FormattingInfoPrivate, m_priv)
46 
47  public:
52 
53 
54 
61  const bool leftAlign, const int minLength, const int maxLength);
63 
68  static FormattingInfoPtr getDefault();
69 
74  bool isLeftAligned() const;
75 
80  int getMinLength() const;
81 
86  int getMaxLength() const;
87 
94  void format(const int fieldStart, LogString& buffer) const;
95 };
97 }
98 }
99 
100 
101 #endif
Modifies the output of a pattern converter for a specified minimum and maximum width and alignment.
Definition: formattinginfo.h:44
std::shared_ptr< FormattingInfo > FormattingInfoPtr
Definition: formattinginfo.h:31
LOG4CXX_PTR_DEF(FormattingInfo)
std::basic_string< logchar > LogString
Definition: logstring.h:60
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:158
#define DECLARE_ABSTRACT_LOG4CXX_OBJECT(object)
Definition: object.h:39
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:152
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:146