Apache Log4cxx  Version 1.8.0
optionhandler.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_SPI_OPTION_HANDLER_H
19 #define _LOG4CXX_SPI_OPTION_HANDLER_H
20 
21 #include <log4cxx/logstring.h>
22 #include <log4cxx/helpers/object.h>
23 
24 namespace LOG4CXX_NS
25 {
26 namespace spi
27 {
28 class OptionHandler;
29 typedef std::shared_ptr<OptionHandler> OptionHandlerPtr;
30 
34 class LOG4CXX_EXPORT OptionHandler : public virtual helpers::Object
35 {
36  public:
38  virtual ~OptionHandler() {}
39 
52 #if LOG4CXX_ABI_VERSION <= 15
53 #define LOG4CXX_ACTIVATE_OPTIONS_FORMAL_PARAMETERS helpers::Pool& p
54 #define LOG4CXX_ACTIVATE_OPTIONS_PARAMETER p
60  virtual void activateOptions(helpers::Pool&) = 0;
61 #else
62 #define LOG4CXX_ACTIVATE_OPTIONS_FORMAL_PARAMETERS
63 #define LOG4CXX_ACTIVATE_OPTIONS_PARAMETER
64  virtual void activateOptions() = 0;
69  [[deprecated("Use activateOptions() without parameters instead")]]
70  void activateOptions(helpers::Pool&);
71 #endif
72 
81  virtual void setOption(const LogString& option,
82  const LogString& value) = 0;
83 
84 }; // class OptionConverter
85 } // namespace spi
86 } // namespace log4cxx
87 
88 
89 #if 15 < LOG4CXX_ABI_VERSION
90 #define LOG4CXX_16_VIRTUAL_SPECIFIER override
91 #else
92 #define LOG4CXX_16_VIRTUAL_SPECIFIER
93 #endif
94 
95 #endif //_LOG4CXX_SPI_OPTION_HANDLER_H
base class for java-like objects.
Definition: object.h:102
Definition: pool.h:33
A string based interface to configure package components.
Definition: optionhandler.h:35
virtual void activateOptions(helpers::Pool &)=0
virtual void setOption(const LogString &option, const LogString &value)=0
Set option to value.
std::shared_ptr< OptionHandler > OptionHandlerPtr
Definition: optionhandler.h:28
std::basic_string< logchar > LogString
Definition: logstring.h:60
#define DECLARE_ABSTRACT_LOG4CXX_OBJECT(object)
Definition: object.h:37