Apache Log4cxx  Version 1.3.1
xmllayout.h
Go to the documentation of this file.
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_XML_LAYOUT_H
19 #define _LOG4CXX_XML_LAYOUT_H
20 
21 #include <log4cxx/layout.h>
22 
23 namespace LOG4CXX_NS
24 {
25 namespace xml
26 {
27 
53 class LOG4CXX_EXPORT XMLLayout : public Layout
54 {
55  private:
56  LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(XMLLayoutPrivate, m_priv)
57 
58  public:
64 
67 
79  void setLocationInfo(bool locationInfo1);
80 
84  bool getLocationInfo() const;
85 
91  void setProperties(bool flag);
92 
98  bool getProperties();
99 
105  void activateOptions(helpers::Pool& /* p */) override { }
106 
115  void setOption(const LogString& option,
116  const LogString& value) override;
117 
122  void format(LogString& output,
123  const spi::LoggingEventPtr& event,
124  helpers::Pool& p) const override;
125 
130  bool ignoresThrowable() const override
131  {
132  return false;
133  }
134 
135 }; // class XMLLayout
137 } // namespace xml
138 } // namespace log4cxx
139 
140 #endif // _LOG4CXX_XML_LAYOUT_H
Extend this abstract class to create your own log layout format.
Definition: layout.h:34
Definition: pool.h:33
The output of the XMLLayout consists of a series of log4j:event elements.
Definition: xmllayout.h:54
bool ignoresThrowable() const override
The XMLLayout prints and does not ignore exceptions.
Definition: xmllayout.h:130
void setOption(const LogString &option, const LogString &value) override
Set option to value.
void format(LogString &output, const spi::LoggingEventPtr &event, helpers::Pool &p) const override
Formats a LoggingEvent in conformance with the log4cxx.dtd.
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:31
LOG4CXX_PTR_DEF(XMLLayout)
std::basic_string< logchar > LogString
Definition: logstring.h:60
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:158
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:152
#define DECLARE_LOG4CXX_OBJECT(object)
Definition: object.h:43
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition: object.h:164
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:146