71 lines
2.1 KiB
C++
71 lines
2.1 KiB
C++
/*
|
|
* Copyright 2003,2004 The Apache Software Foundation.
|
|
*
|
|
* Licensed 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_SPI_OPTION_HANDLER_H
|
|
#define _LOG4CXX_SPI_OPTION_HANDLER_H
|
|
|
|
#include <log4cxx/helpers/tchar.h>
|
|
#include <log4cxx/helpers/object.h>
|
|
#include <log4cxx/helpers/objectptr.h>
|
|
|
|
namespace log4cxx
|
|
{
|
|
namespace spi
|
|
{
|
|
class OptionHandler;
|
|
typedef helpers::ObjectPtrT<OptionHandler> OptionHandlerPtr;
|
|
|
|
/**
|
|
A string based interface to configure package components.
|
|
*/
|
|
class LOG4CXX_EXPORT OptionHandler : public virtual helpers::Object
|
|
{
|
|
public:
|
|
DECLARE_ABSTRACT_LOG4CXX_OBJECT(OptionHandler)
|
|
virtual ~OptionHandler() {}
|
|
|
|
/**
|
|
Activate the options that were previously set with calls to option
|
|
setters.
|
|
|
|
<p>This allows to defer activiation of the options until all
|
|
options have been set. This is required for components which have
|
|
related options that remain ambigous until all are set.
|
|
|
|
<p>For example, the FileAppender has the {@link
|
|
FileAppender#setFile File} and {@link
|
|
FileAppender#setAppend Append} options both of
|
|
which are ambigous until the other is also set. */
|
|
virtual void activateOptions() = 0;
|
|
|
|
|
|
/**
|
|
Set <code>option</code> to <code>value</code>.
|
|
|
|
<p>The handling of each option depends on the OptionHandler
|
|
instance. Some options may become active immediately whereas
|
|
other may be activated only when #activateOptions is
|
|
called.
|
|
*/
|
|
virtual void setOption(const String& option, const String& value) = 0;
|
|
|
|
}; // class OptionConverter
|
|
} // namespace spi
|
|
}; // namespace log4cxx
|
|
|
|
|
|
#endif //_LOG4CXX_SPI_OPTION_HANDLER_H
|