Apache Log4cxx
Version 1.8.0
Toggle main menu visibility
Loading...
Searching...
No Matches
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
:
59
DECLARE_LOG4CXX_OBJECT
(
XMLLayout
)
60
BEGIN_LOG4CXX_CAST_MAP
()
61
LOG4CXX_CAST_ENTRY
(
XMLLayout
)
62
LOG4CXX_CAST_ENTRY_CHAIN
(
Layout
)
63
END_LOG4CXX_CAST_MAP
()
64
65
XMLLayout
();
66
~
XMLLayout
();
67
79
void
setLocationInfo
(
bool
locationInfo1);
80
84
bool
getLocationInfo
() const;
85
91
void
setProperties
(
bool
flag);
92
98
bool
getProperties
();
99
100
#if LOG4CXX_ABI_VERSION <= 15
101
using
Layout::activateOptions
;
107
void
activateOptions
(
LOG4CXX_ACTIVATE_OPTIONS_FORMAL_PARAMETERS
)
override
{ }
108
#endif
117
void
setOption
(
const
LogString
& option,
118
const
LogString
& value)
override
;
119
120
using
Layout::format
;
125
void
format
(
LOG4CXX_FORMAT_LAYOUT_FORMAL_PARAMETERS
)
const override
;
126
131
bool
ignoresThrowable
()
const override
132
{
133
return
false
;
134
}
135
136
};
// class XMLLayout
137
LOG4CXX_PTR_DEF
(
XMLLayout
);
138
}
// namespace xml
139
}
// namespace log4cxx
140
141
#endif
// _LOG4CXX_XML_LAYOUT_H
log4cxx::Layout
Extend this abstract class to create your own log layout format.
Definition
layout.h:38
log4cxx::Layout::format
void format(LogString &output, const spi::LoggingEventPtr &event) const
Implement this method to create your own layout format.
log4cxx::spi::OptionHandler::activateOptions
void activateOptions()
log4cxx::xml::XMLLayout
The output of the XMLLayout consists of a series of log4j:event elements.
Definition
xmllayout.h:54
log4cxx::xml::XMLLayout::setLocationInfo
void setLocationInfo(bool locationInfo1)
The LocationInfo option takes a boolean value.
log4cxx::xml::XMLLayout::activateOptions
void activateOptions(helpers::Pool &p) override
Definition
xmllayout.h:107
log4cxx::xml::XMLLayout::ignoresThrowable
bool ignoresThrowable() const override
The XMLLayout prints and does not ignore exceptions.
Definition
xmllayout.h:131
log4cxx::xml::XMLLayout::getProperties
bool getProperties()
Gets whether MDC key-value pairs should be output.
log4cxx::xml::XMLLayout::setOption
void setOption(const LogString &option, const LogString &value) override
Set option to value.
log4cxx::xml::XMLLayout::setProperties
void setProperties(bool flag)
Sets whether MDC key-value pairs should be output, default false.
log4cxx::xml::XMLLayout::getLocationInfo
bool getLocationInfo() const
Returns the current value of the LocationInfo option.
log4cxx::xml::XMLLayout::XMLLayout
XMLLayout()
log4cxx::xml::XMLLayout::format
void format(LogString &output, const spi::LoggingEventPtr &event, helpers::Pool &p) const override
Formats a LoggingEvent in conformance with this XML data definition file.
layout.h
LOG4CXX_FORMAT_LAYOUT_FORMAL_PARAMETERS
#define LOG4CXX_FORMAT_LAYOUT_FORMAL_PARAMETERS
Definition
layout.h:59
log4cxx::xml::LOG4CXX_PTR_DEF
LOG4CXX_PTR_DEF(DOMConfigurator)
log4cxx::LogString
std::basic_string< logchar > LogString
Definition
logstring.h:60
LOG4CXX_CAST_ENTRY
#define LOG4CXX_CAST_ENTRY(Interface)
Definition
object.h:154
END_LOG4CXX_CAST_MAP
#define END_LOG4CXX_CAST_MAP()
Definition
object.h:148
DECLARE_LOG4CXX_OBJECT
#define DECLARE_LOG4CXX_OBJECT(object)
Definition
object.h:41
LOG4CXX_CAST_ENTRY_CHAIN
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition
object.h:160
BEGIN_LOG4CXX_CAST_MAP
#define BEGIN_LOG4CXX_CAST_MAP()
Definition
object.h:142
LOG4CXX_ACTIVATE_OPTIONS_FORMAL_PARAMETERS
#define LOG4CXX_ACTIVATE_OPTIONS_FORMAL_PARAMETERS
Activate the options that were previously set with calls to option setters.
Definition
optionhandler.h:53
src
main
include
log4cxx
xml
xmllayout.h
Generated by
1.17.0 on
SITE_PUBLISHED_DATE
Copyright © 2017-2026
Apache Software Foundation
. Apache, Chainsaw, log4cxx, Log4j, Log4net, log4php and the Apache logo are
trademarks or registered trademarks
of The Apache Software Foundation.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Privacy Policy
.