[80] | 1 | // |
---|
| 2 | // Formatter.h |
---|
| 3 | // |
---|
| 4 | // $Id: //poco/1.3/Foundation/include/Poco/Formatter.h#1 $ |
---|
| 5 | // |
---|
| 6 | // Library: Foundation |
---|
| 7 | // Package: Logging |
---|
| 8 | // Module: Formatter |
---|
| 9 | // |
---|
| 10 | // Definition of the Formatter class. |
---|
| 11 | // |
---|
| 12 | // Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. |
---|
| 13 | // and Contributors. |
---|
| 14 | // |
---|
| 15 | // Permission is hereby granted, free of charge, to any person or organization |
---|
| 16 | // obtaining a copy of the software and accompanying documentation covered by |
---|
| 17 | // this license (the "Software") to use, reproduce, display, distribute, |
---|
| 18 | // execute, and transmit the Software, and to prepare derivative works of the |
---|
| 19 | // Software, and to permit third-parties to whom the Software is furnished to |
---|
| 20 | // do so, all subject to the following: |
---|
| 21 | // |
---|
| 22 | // The copyright notices in the Software and this entire statement, including |
---|
| 23 | // the above license grant, this restriction and the following disclaimer, |
---|
| 24 | // must be included in all copies of the Software, in whole or in part, and |
---|
| 25 | // all derivative works of the Software, unless such copies or derivative |
---|
| 26 | // works are solely in the form of machine-executable object code generated by |
---|
| 27 | // a source language processor. |
---|
| 28 | // |
---|
| 29 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
| 30 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
| 31 | // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT |
---|
| 32 | // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE |
---|
| 33 | // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, |
---|
| 34 | // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
---|
| 35 | // DEALINGS IN THE SOFTWARE. |
---|
| 36 | // |
---|
| 37 | |
---|
| 38 | |
---|
| 39 | #ifndef Foundation_Formatter_INCLUDED |
---|
| 40 | #define Foundation_Formatter_INCLUDED |
---|
| 41 | |
---|
| 42 | |
---|
| 43 | #include "Poco/Foundation.h" |
---|
| 44 | #include "Poco/Configurable.h" |
---|
| 45 | #include "Poco/RefCountedObject.h" |
---|
| 46 | |
---|
| 47 | |
---|
| 48 | namespace Poco { |
---|
| 49 | |
---|
| 50 | |
---|
| 51 | class Message; |
---|
| 52 | |
---|
| 53 | |
---|
| 54 | class Foundation_API Formatter: public Configurable, public RefCountedObject |
---|
| 55 | /// The base class for all Formatter classes. |
---|
| 56 | /// |
---|
| 57 | /// A formatter basically takes a Message object |
---|
| 58 | /// and formats it into a string. How the formatting |
---|
| 59 | /// is exactly done is up to the implementation of |
---|
| 60 | /// Formatter. For example, a very simple implementation |
---|
| 61 | /// might simply take the message's Text (see Message::getText()). |
---|
| 62 | /// A useful implementation should at least take the Message's |
---|
| 63 | /// Time, Priority and Text fields and put them into a string. |
---|
| 64 | /// |
---|
| 65 | /// The Formatter class supports the Configurable |
---|
| 66 | /// interface, so the behaviour of certain formatters |
---|
| 67 | /// is configurable. |
---|
| 68 | /// |
---|
| 69 | /// Trivial implementations of of getProperty() and |
---|
| 70 | /// setProperty() are provided. |
---|
| 71 | /// |
---|
| 72 | /// Subclasses must at least provide a format() method. |
---|
| 73 | { |
---|
| 74 | public: |
---|
| 75 | Formatter(); |
---|
| 76 | /// Creates the formatter. |
---|
| 77 | |
---|
| 78 | virtual ~Formatter(); |
---|
| 79 | /// Destroys the formatter. |
---|
| 80 | |
---|
| 81 | virtual void format(const Message& msg, std::string& text) = 0; |
---|
| 82 | /// Formats the message and places the result in text. |
---|
| 83 | /// Subclasses must override this method. |
---|
| 84 | |
---|
| 85 | void setProperty(const std::string& name, const std::string& value); |
---|
| 86 | /// Throws a PropertyNotSupportedException. |
---|
| 87 | |
---|
| 88 | std::string getProperty(const std::string& name) const; |
---|
| 89 | /// Throws a PropertyNotSupportedException. |
---|
| 90 | }; |
---|
| 91 | |
---|
| 92 | |
---|
| 93 | } // namespace Poco |
---|
| 94 | |
---|
| 95 | |
---|
| 96 | #endif // Foundation_Formatter_INCLUDED |
---|