/src/logging-log4cxx/src/main/include/log4cxx/helpers/reader.h
Line | Count | Source |
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_HELPERS_READER_H |
19 | | #define _LOG4CXX_HELPERS_READER_H |
20 | | |
21 | | #include <log4cxx/helpers/object.h> |
22 | | |
23 | | namespace LOG4CXX_NS |
24 | | { |
25 | | |
26 | | namespace helpers |
27 | | { |
28 | | |
29 | | /** |
30 | | * Abstract class for reading from character streams. |
31 | | * |
32 | | */ |
33 | | class LOG4CXX_EXPORT Reader : public Object |
34 | | { |
35 | | public: |
36 | | DECLARE_ABSTRACT_LOG4CXX_OBJECT(Reader) |
37 | 0 | BEGIN_LOG4CXX_CAST_MAP() |
38 | 0 | LOG4CXX_CAST_ENTRY(Reader) |
39 | 0 | END_LOG4CXX_CAST_MAP() |
40 | | |
41 | | protected: |
42 | | /** |
43 | | * Creates a new character-stream reader. |
44 | | */ |
45 | | Reader(); |
46 | | |
47 | | virtual ~Reader(); |
48 | | |
49 | | public: |
50 | | #if LOG4CXX_ABI_VERSION <= 15 |
51 | | /** |
52 | | * Closes the stream. |
53 | | */ |
54 | | void close(); |
55 | | |
56 | | /** |
57 | | * @return The complete stream contents as a LogString. |
58 | | */ |
59 | | LogString read(); |
60 | | |
61 | | /** |
62 | | @deprecated The \c pool parameter is not used and will be removed in a future version. |
63 | | Implement this method for now, but plan to migrate to close() without a helpers::Pool parameter. |
64 | | */ |
65 | | virtual void close(Pool& p) = 0; |
66 | | #define LOG4CXX_CLOSE_READER_FORMAL_PARAMETERS helpers::Pool& p |
67 | | /** |
68 | | @deprecated The \c pool parameter is not used and will be removed in a future version. |
69 | | Implement this method for now, but plan to migrate to read() without a helpers::Pool parameter. |
70 | | */ |
71 | | virtual LogString read(Pool& p) = 0; |
72 | | #define LOG4CXX_READ_READER_FORMAL_PARAMETERS helpers::Pool& p |
73 | | #else |
74 | | /** |
75 | | * Closes the stream. |
76 | | */ |
77 | | virtual void close() = 0; |
78 | | #define LOG4CXX_CLOSE_READER_FORMAL_PARAMETERS |
79 | | |
80 | | /** |
81 | | * @return The complete stream contents as a LogString. |
82 | | */ |
83 | | virtual LogString read() = 0; |
84 | | #define LOG4CXX_READ_READER_FORMAL_PARAMETERS |
85 | | /** |
86 | | @deprecated The \c pool parameter is not used and will be removed in a future version. |
87 | | */ |
88 | | [[deprecated("Use close() without a Pool parameter instead")]] |
89 | | void close(Pool& p); |
90 | | /** |
91 | | @deprecated The \c pool parameter is not used and will be removed in a future version. |
92 | | */ |
93 | | [[deprecated("Use read() without a Pool parameter instead")]] |
94 | | LogString read(Pool& p); |
95 | | #endif |
96 | | |
97 | | private: |
98 | | Reader(const Reader&); |
99 | | |
100 | | Reader& operator=(const Reader&); |
101 | | }; |
102 | | |
103 | | LOG4CXX_PTR_DEF(Reader); |
104 | | } // namespace helpers |
105 | | |
106 | | } //namespace log4cxx |
107 | | |
108 | | #endif //_LOG4CXX_HELPERS_READER_H |