blob: 678d594b72e478129b5271ff0df13af7e892dfe7 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
//
// Formatter.h
//
// Library: Foundation
// Package: Logging
// Module: Formatter
//
// Definition of the Formatter class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// SPDX-License-Identifier: BSL-1.0
//
#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
|
