89 lines
2.4 KiB
C++
89 lines
2.4 KiB
C++
/*
|
|
* Copyright 2003,2004 The Apache Software Foundation.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef _LOG4CXX_LAYOUT_H
|
|
#define _LOG4CXX_LAYOUT_H
|
|
|
|
#include <log4cxx/helpers/objectimpl.h>
|
|
#include <log4cxx/helpers/objectptr.h>
|
|
#include <log4cxx/spi/optionhandler.h>
|
|
|
|
namespace log4cxx
|
|
{
|
|
class Layout;
|
|
typedef helpers::ObjectPtrT<Layout> LayoutPtr;
|
|
|
|
namespace spi
|
|
{
|
|
class LoggingEvent;
|
|
typedef helpers::ObjectPtrT<LoggingEvent> LoggingEventPtr;
|
|
}
|
|
|
|
/**
|
|
Extend this abstract class to create your own log layout format.
|
|
*/
|
|
class LOG4CXX_EXPORT Layout :
|
|
public virtual spi::OptionHandler,
|
|
public virtual helpers::ObjectImpl
|
|
{
|
|
public:
|
|
DECLARE_ABSTRACT_LOG4CXX_OBJECT(Layout)
|
|
BEGIN_LOG4CXX_CAST_MAP()
|
|
LOG4CXX_CAST_ENTRY(Layout)
|
|
LOG4CXX_CAST_ENTRY(spi::OptionHandler)
|
|
END_LOG4CXX_CAST_MAP()
|
|
|
|
virtual ~Layout() {}
|
|
|
|
/**
|
|
Implement this method to create your own layout format.
|
|
*/
|
|
virtual void format(ostream& output, const spi::LoggingEventPtr& event) const = 0;
|
|
|
|
/**
|
|
Returns the content type output by this layout. The base class
|
|
returns "text/plain".
|
|
*/
|
|
virtual String getContentType() const { return _T("text/plain"); }
|
|
|
|
/**
|
|
Append the header for the layout format. The base class does
|
|
nothing.
|
|
*/
|
|
virtual void appendHeader(ostream& output) {}
|
|
|
|
/**
|
|
Append the footer for the layout format. The base class does
|
|
nothing.
|
|
*/
|
|
virtual void appendFooter(ostream& output) {}
|
|
|
|
/**
|
|
If the layout handles the throwable object contained within
|
|
{@link spi::LoggingEvent LoggingEvent}, then the layout should return
|
|
<code>false</code>. Otherwise, if the layout ignores throwable
|
|
object, then the layout should return <code>true</code>.
|
|
|
|
<p>The SimpleLayout, TTCCLayout,
|
|
PatternLayout all return <code>true</code>. The {@link
|
|
xml::XMLLayout XMLLayout} returns <code>false</code>.
|
|
*/
|
|
virtual bool ignoresThrowable() const = 0;
|
|
};
|
|
}
|
|
|
|
#endif // _LOG4CXX_LAYOUT_H
|