src/main/include/log4cxx/pattern/mdcpatternconverter.h

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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_PATTERN_MDC_PATTERN_CONVERTER
#define _LOG4CXX_PATTERN_MDC_PATTERN_CONVERTER

#include <log4cxx/pattern/loggingeventpatternconverter.h>

namespace LOG4CXX_NS
{
namespace pattern
{


/**
 * Provides all key value pairs in JSON or a single value from an event's mapped diagnostic context
 */
class LOG4CXX_EXPORT MDCPatternConverter : public LoggingEventPatternConverter
{
	public:
		DECLARE_LOG4CXX_PATTERN(MDCPatternConverter)
		BEGIN_LOG4CXX_CAST_MAP()
		LOG4CXX_CAST_ENTRY(MDCPatternConverter)
		LOG4CXX_CAST_ENTRY_CHAIN(LoggingEventPatternConverter)
		END_LOG4CXX_CAST_MAP()

		MDCPatternConverter
			( const LogString&              name = LogString()
			, const LogString&              style = LogString()
			, const std::vector<LogString>& options = std::vector<LogString>()
			);

		/**
		 * An instance of MDCPatternConverter.
		 * @param options if not empty, options[0][0] is the character to duplicate
		 */
		static PatternConverterPtr newInstance(const std::vector<LogString>& options);

		using LoggingEventPatternConverter::format;

		void format( LOG4CXX_FORMAT_EVENT_FORMAL_PARAMETERS ) const override;
};
}
}
#endif