Coverage Report

Created: 2025-07-01 06:08

/src/logging-log4cxx/src/main/include/log4cxx/pattern/mdcpatternconverter.h
Line
Count
Source (jump to first uncovered line)
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_PATTERN_MDC_PATTERN_CONVERTER
19
#define _LOG4CXX_PATTERN_MDC_PATTERN_CONVERTER
20
21
#include <log4cxx/pattern/loggingeventpatternconverter.h>
22
23
namespace LOG4CXX_NS
24
{
25
namespace pattern
26
{
27
28
29
/**
30
 * Provides all key value pairs in JSON or a single value from an event's mapped diagnostic context
31
 */
32
class LOG4CXX_EXPORT MDCPatternConverter : public LoggingEventPatternConverter
33
{
34
  public:
35
    DECLARE_LOG4CXX_PATTERN(MDCPatternConverter)
36
0
    BEGIN_LOG4CXX_CAST_MAP()
37
0
    LOG4CXX_CAST_ENTRY(MDCPatternConverter)
38
0
    LOG4CXX_CAST_ENTRY_CHAIN(LoggingEventPatternConverter)
39
0
    END_LOG4CXX_CAST_MAP()
40
41
    MDCPatternConverter
42
      ( const LogString&              name = LogString()
43
      , const LogString&              style = LogString()
44
      , const std::vector<LogString>& options = std::vector<LogString>()
45
      );
46
47
    /**
48
     * An instance of MDCPatternConverter.
49
     * @param options if not empty, options[0][0] is the character to duplicate
50
     */
51
    static PatternConverterPtr newInstance(const std::vector<LogString>& options);
52
53
    using LoggingEventPatternConverter::format;
54
55
    void format
56
      ( const spi::LoggingEventPtr& event
57
      , LogString&                  toAppendTo
58
      , helpers::Pool&              p
59
      ) const override;
60
};
61
}
62
}
63
#endif