Apache Log4cxx  Version 1.8.0
reader.h
Go to the documentation of this file.
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 
33 class LOG4CXX_EXPORT Reader : public Object
34 {
35  public:
40 
41  protected:
45  Reader();
46 
47  virtual ~Reader();
48 
49  public:
50 #if LOG4CXX_ABI_VERSION <= 15
54  void close();
55 
60 
65  virtual void close(Pool& p) = 0;
66 #define LOG4CXX_CLOSE_READER_FORMAL_PARAMETERS helpers::Pool& p
71  virtual LogString read(Pool& p) = 0;
72 #define LOG4CXX_READ_READER_FORMAL_PARAMETERS helpers::Pool& p
73 #else
77  virtual void close() = 0;
78 #define LOG4CXX_CLOSE_READER_FORMAL_PARAMETERS
79 
83  virtual LogString read() = 0;
84 #define LOG4CXX_READ_READER_FORMAL_PARAMETERS
88  [[deprecated("Use close() without a Pool parameter instead")]]
89  void close(Pool& p);
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 
104 } // namespace helpers
105 
106 } //namespace log4cxx
107 
108 #endif //_LOG4CXX_HELPERS_READER_H
base class for java-like objects.
Definition: object.h:102
Definition: pool.h:33
Abstract class for reading from character streams.
Definition: reader.h:34
void close()
Closes the stream.
virtual LogString read(Pool &p)=0
virtual void close(Pool &p)=0
Reader()
Creates a new character-stream reader.
LOG4CXX_PTR_DEF(Reader)
std::basic_string< logchar > LogString
Definition: logstring.h:60
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:154
#define DECLARE_ABSTRACT_LOG4CXX_OBJECT(object)
Definition: object.h:37
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:148
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:142