| 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 | #include <log4cxx/helpers/objectptr.h>
|
|---|
| 24 |
|
|---|
| 25 | namespace log4cxx
|
|---|
| 26 | {
|
|---|
| 27 | namespace spi
|
|---|
| 28 | {
|
|---|
| 29 | class OptionHandler;
|
|---|
| 30 | typedef helpers::ObjectPtrT<OptionHandler> OptionHandlerPtr;
|
|---|
| 31 |
|
|---|
| 32 | /**
|
|---|
| 33 | A string based interface to configure package components.
|
|---|
| 34 | */
|
|---|
| 35 | class LOG4CXX_EXPORT OptionHandler : public virtual helpers::Object
|
|---|
| 36 | {
|
|---|
| 37 | public:
|
|---|
| 38 | DECLARE_ABSTRACT_LOG4CXX_OBJECT(OptionHandler)
|
|---|
| 39 | virtual ~OptionHandler() {}
|
|---|
| 40 |
|
|---|
| 41 | /**
|
|---|
| 42 | Activate the options that were previously set with calls to option
|
|---|
| 43 | setters.
|
|---|
| 44 |
|
|---|
| 45 | <p>This allows to defer activiation of the options until all
|
|---|
| 46 | options have been set. This is required for components which have
|
|---|
| 47 | related options that remain ambigous until all are set.
|
|---|
| 48 |
|
|---|
| 49 | <p>For example, the FileAppender has the {@link
|
|---|
| 50 | FileAppender#setFile File} and {@link
|
|---|
| 51 | FileAppender#setAppend Append} options both of
|
|---|
| 52 | which are ambigous until the other is also set. */
|
|---|
| 53 | virtual void activateOptions(log4cxx::helpers::Pool& p) = 0;
|
|---|
| 54 |
|
|---|
| 55 |
|
|---|
| 56 | /**
|
|---|
| 57 | Set <code>option</code> to <code>value</code>.
|
|---|
| 58 |
|
|---|
| 59 | <p>The handling of each option depends on the OptionHandler
|
|---|
| 60 | instance. Some options may become active immediately whereas
|
|---|
| 61 | other may be activated only when #activateOptions is
|
|---|
| 62 | called.
|
|---|
| 63 | */
|
|---|
| 64 | virtual void setOption(const LogString& option,
|
|---|
| 65 | const LogString& value) = 0;
|
|---|
| 66 |
|
|---|
| 67 | }; // class OptionConverter
|
|---|
| 68 | } // namespace spi
|
|---|
| 69 | } // namespace log4cxx
|
|---|
| 70 |
|
|---|
| 71 |
|
|---|
| 72 | #endif //_LOG4CXX_SPI_OPTION_HANDLER_H
|
|---|
