Apache Log4cxx  Version 1.1.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 #include <log4cxx/helpers/object.h>
24 
25 
26 namespace log4cxx
27 {
31 class LOG4CXX_EXPORT Layout :
32  public virtual spi::OptionHandler,
33  public virtual helpers::Object
34 {
35  public:
41 
42  virtual ~Layout();
43 
47  virtual void format(LogString& output,
48  const spi::LoggingEventPtr& event, log4cxx::helpers::Pool& pool) const = 0;
49 
54  virtual LogString getContentType() const;
55 
60  virtual void appendHeader(LogString& output, log4cxx::helpers::Pool& p);
61 
66  virtual void appendFooter(LogString& output, log4cxx::helpers::Pool& p);
67 
78  virtual bool ignoresThrowable() const = 0;
79 };
81 }
82 
83 #endif // _LOG4CXX_LAYOUT_H
Extend this abstract class to create your own log layout format.
Definition: layout.h:34
base class for java-like objects.
Definition: object.h:105
A string based interface to configure package components.
Definition: optionhandler.h:35
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:31
Definition: appender.h:27
std::basic_string< logchar > LogString
Definition: logstring.h:60
LOG4CXX_PTR_DEF(Appender)
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:157
#define DECLARE_ABSTRACT_LOG4CXX_OBJECT(object)
Definition: object.h:38
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:151
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:145