Apache Log4cxx  Version 1.1.0
rollingpolicybase.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 #if !defined(_LOG4CXX_ROLLING_ROLLING_POLICY_BASE_H)
19 #define _LOG4CXX_ROLLING_ROLLING_POLICY_BASE_H
20 
21 #include <log4cxx/helpers/object.h>
22 #include <log4cxx/logger.h>
23 #include <log4cxx/logmanager.h>
28 
29 namespace log4cxx
30 {
31 namespace rolling
32 {
33 LOG4CXX_LIST_DEF(PatternConverterList, log4cxx::pattern::PatternConverterPtr);
35 
43 class LOG4CXX_EXPORT RollingPolicyBase :
44  public virtual RollingPolicy,
45  public virtual helpers::Object
46 {
47  protected:
53 
54  LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(RollingPolicyBasePrivate, m_priv)
55 
56  public:
58  virtual ~RollingPolicyBase();
61 
62  void setOption(const LogString& option, const LogString& value) override;
63 
68  void setFileNamePattern(const LogString& fnp);
69 
75 
77  void setCreateIntermediateDirectories(bool createIntermediate);
78 
79  PatternConverterList getPatternConverterList() const;
80 
81  protected:
82  RollingPolicyBase(LOG4CXX_PRIVATE_PTR(RollingPolicyBasePrivate) priv);
87 
96  LogString& buf, helpers::Pool& p) const;
97 
98  log4cxx::pattern::PatternConverterPtr getIntegerPatternConverter() const;
99  log4cxx::pattern::PatternConverterPtr getDatePatternConverter() const;
100 };
101 
103 
104 }
105 }
106 
107 #endif
base class for java-like objects.
Definition: object.h:105
Definition: pool.h:33
Implements methods common to most, it not all, rolling policies.
Definition: rollingpolicybase.h:46
void activateOptions(log4cxx::helpers::Pool &p) override
Activate the options that were previously set with calls to option setters.
log4cxx::pattern::PatternConverterPtr getIntegerPatternConverter() const
void formatFileName(const helpers::ObjectPtr &obj, LogString &buf, helpers::Pool &p) const
Format file name.
void parseFileNamePattern()
Parse file name pattern.
LogString getFileNamePattern() const
Get file name pattern.
RollingPolicyBase(LOG4CXX_PRIVATE_PTR(RollingPolicyBasePrivate) priv)
PatternConverterList getPatternConverterList() const
log4cxx::pattern::PatternConverterPtr getDatePatternConverter() const
virtual log4cxx::pattern::PatternMap getFormatSpecifiers() const =0
void setCreateIntermediateDirectories(bool createIntermediate)
void setFileNamePattern(const LogString &fnp)
Set file name pattern.
void setOption(const LogString &option, const LogString &value) override
Set option to value.
A RollingPolicy is responsible for performing the rolling over of the active log file.
Definition: rollingpolicy.h:43
A string based interface to configure package components.
Definition: optionhandler.h:35
std::shared_ptr< Object > ObjectPtr
Definition: optionconverter.h:40
std::map< LogString, PatternConstructor > PatternMap
Definition: patternparser.h:35
std::shared_ptr< FormattingInfo > FormattingInfoPtr
Definition: formattinginfo.h:31
LOG4CXX_PTR_DEF(Action)
LOG4CXX_LIST_DEF(PatternConverterList, log4cxx::pattern::PatternConverterPtr)
Definition: appender.h:27
std::basic_string< logchar > LogString
Definition: logstring.h:60
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:157
#define DECLARE_ABSTRACT_LOG4CXX_OBJECT(object)
Definition: object.h:38
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:151
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:145