| 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_PROPERTIES_PATTERN_CONVERTER
|
|---|
| 19 | #define _LOG4CXX_PATTERN_PROPERTIES_PATTERN_CONVERTER
|
|---|
| 20 |
|
|---|
| 21 | #include <log4cxx/pattern/loggingeventpatternconverter.h>
|
|---|
| 22 |
|
|---|
| 23 | namespace log4cxx { namespace pattern {
|
|---|
| 24 |
|
|---|
| 25 |
|
|---|
| 26 | /**
|
|---|
| 27 | * Able to handle the contents of the LoggingEvent's Property bundle and either
|
|---|
| 28 | * output the entire contents of the properties in a similar format to the
|
|---|
| 29 | * java.util.Hashtable.toString(), or to output the value of a specific key
|
|---|
| 30 | * within the property bundle
|
|---|
| 31 | * when this pattern converter has the option set.
|
|---|
| 32 | *
|
|---|
| 33 | *
|
|---|
| 34 | *
|
|---|
| 35 | */
|
|---|
| 36 | class LOG4CXX_EXPORT PropertiesPatternConverter
|
|---|
| 37 | : public LoggingEventPatternConverter {
|
|---|
| 38 | /**
|
|---|
| 39 | * Name of property to output.
|
|---|
| 40 | */
|
|---|
| 41 | const LogString option;
|
|---|
| 42 |
|
|---|
| 43 | /**
|
|---|
| 44 | * Private constructor.
|
|---|
| 45 | * @param options options, may be null.
|
|---|
| 46 | * @param logger logger for diagnostic messages, may be null.
|
|---|
| 47 | */
|
|---|
| 48 | PropertiesPatternConverter(const LogString& name, const LogString& option);
|
|---|
| 49 |
|
|---|
| 50 | public:
|
|---|
| 51 | DECLARE_LOG4CXX_PATTERN(PropertiesPatternConverter)
|
|---|
| 52 | BEGIN_LOG4CXX_CAST_MAP()
|
|---|
| 53 | LOG4CXX_CAST_ENTRY(PropertiesPatternConverter)
|
|---|
| 54 | LOG4CXX_CAST_ENTRY_CHAIN(LoggingEventPatternConverter)
|
|---|
| 55 | END_LOG4CXX_CAST_MAP()
|
|---|
| 56 |
|
|---|
| 57 | /**
|
|---|
| 58 | * Obtains an instance of PropertiesPatternConverter.
|
|---|
| 59 | * @param options options, may be null or first element contains name of property to format.
|
|---|
| 60 | * @return instance of PropertiesPatternConverter.
|
|---|
| 61 | */
|
|---|
| 62 | static PatternConverterPtr newInstance(
|
|---|
| 63 | const std::vector<LogString>& options);
|
|---|
| 64 | void format(const log4cxx::spi::LoggingEventPtr& event,
|
|---|
| 65 | LogString& toAppendTo,
|
|---|
| 66 | log4cxx::helpers::Pool& p) const;
|
|---|
| 67 | };
|
|---|
| 68 | }
|
|---|
| 69 | }
|
|---|
| 70 | #endif
|
|---|
| 71 |
|
|---|
