Apache log4cxx  Version 0.12.0
layout.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_LAYOUT_H
19 #define _LOG4CXX_LAYOUT_H
20 
21 #if defined(_MSC_VER)
22  #pragma warning ( push )
23  #pragma warning ( disable: 4231 4251 4275 4786 )
24 #endif
25 
26 
27 #include <log4cxx/helpers/object.h>
30 
31 
32 namespace log4cxx
33 {
37 class LOG4CXX_EXPORT Layout :
38  public virtual spi::OptionHandler,
39  public virtual helpers::Object
40 {
41  public:
47 
48  virtual ~Layout();
49 
53  virtual void format(LogString& output,
54  const spi::LoggingEventPtr& event, log4cxx::helpers::Pool& pool) const = 0;
55 
60  virtual LogString getContentType() const;
61 
66  virtual void appendHeader(LogString& output, log4cxx::helpers::Pool& p);
67 
72  virtual void appendFooter(LogString& output, log4cxx::helpers::Pool& p);
73 
84  virtual bool ignoresThrowable() const = 0;
85 };
87 }
88 
89 #if defined(_MSC_VER)
90  #pragma warning ( pop )
91 #endif
92 
93 #endif // _LOG4CXX_LAYOUT_H
#define DECLARE_ABSTRACT_LOG4CXX_OBJECT(object)
Definition: object.h:26
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:148
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:142
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:37
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:136
Extend this abstract class to create your own log layout format.
Definition: layout.h:37
LOG4CXX_PTR_DEF(Appender)
base class for java-like objects.
Definition: object.h:101
Definition: pool.h:32
A string based interface to configure package components.
Definition: optionhandler.h:34
Definition: appender.h:32
std::basic_string< logchar > LogString
Definition: logstring.h:66