mirror of
https://github.com/pocoproject/poco.git
synced 2024-12-13 10:32:57 +01:00
97 lines
3.2 KiB
C++
97 lines
3.2 KiB
C++
//
|
|
// Formatter.h
|
|
//
|
|
// $Id: //poco/1.4/Foundation/include/Poco/Formatter.h#1 $
|
|
//
|
|
// Library: Foundation
|
|
// Package: Logging
|
|
// Module: Formatter
|
|
//
|
|
// Definition of the Formatter class.
|
|
//
|
|
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
|
|
// and Contributors.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person or organization
|
|
// obtaining a copy of the software and accompanying documentation covered by
|
|
// this license (the "Software") to use, reproduce, display, distribute,
|
|
// execute, and transmit the Software, and to prepare derivative works of the
|
|
// Software, and to permit third-parties to whom the Software is furnished to
|
|
// do so, all subject to the following:
|
|
//
|
|
// The copyright notices in the Software and this entire statement, including
|
|
// the above license grant, this restriction and the following disclaimer,
|
|
// must be included in all copies of the Software, in whole or in part, and
|
|
// all derivative works of the Software, unless such copies or derivative
|
|
// works are solely in the form of machine-executable object code generated by
|
|
// a source language processor.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
|
|
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
|
|
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
|
|
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
// DEALINGS IN THE SOFTWARE.
|
|
//
|
|
|
|
|
|
#ifndef Foundation_Formatter_INCLUDED
|
|
#define Foundation_Formatter_INCLUDED
|
|
|
|
|
|
#include "Poco/Foundation.h"
|
|
#include "Poco/Configurable.h"
|
|
#include "Poco/RefCountedObject.h"
|
|
|
|
|
|
namespace Poco {
|
|
|
|
|
|
class Message;
|
|
|
|
|
|
class Foundation_API Formatter: public Configurable, public RefCountedObject
|
|
/// The base class for all Formatter classes.
|
|
///
|
|
/// A formatter basically takes a Message object
|
|
/// and formats it into a string. How the formatting
|
|
/// is exactly done is up to the implementation of
|
|
/// Formatter. For example, a very simple implementation
|
|
/// might simply take the message's Text (see Message::getText()).
|
|
/// A useful implementation should at least take the Message's
|
|
/// Time, Priority and Text fields and put them into a string.
|
|
///
|
|
/// The Formatter class supports the Configurable
|
|
/// interface, so the behaviour of certain formatters
|
|
/// is configurable.
|
|
///
|
|
/// Trivial implementations of of getProperty() and
|
|
/// setProperty() are provided.
|
|
///
|
|
/// Subclasses must at least provide a format() method.
|
|
{
|
|
public:
|
|
Formatter();
|
|
/// Creates the formatter.
|
|
|
|
virtual ~Formatter();
|
|
/// Destroys the formatter.
|
|
|
|
virtual void format(const Message& msg, std::string& text) = 0;
|
|
/// Formats the message and places the result in text.
|
|
/// Subclasses must override this method.
|
|
|
|
void setProperty(const std::string& name, const std::string& value);
|
|
/// Throws a PropertyNotSupportedException.
|
|
|
|
std::string getProperty(const std::string& name) const;
|
|
/// Throws a PropertyNotSupportedException.
|
|
};
|
|
|
|
|
|
} // namespace Poco
|
|
|
|
|
|
#endif // Foundation_Formatter_INCLUDED
|