/src/logging-log4cxx/src/main/include/log4cxx/helpers/reader.h

Source
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _LOG4CXX_HELPERS_READER_H
#define _LOG4CXX_HELPERS_READER_H

#include <log4cxx/helpers/object.h>

namespace LOG4CXX_NS
{

namespace helpers
{

/**
 * Abstract class for reading from character streams.
 *
 */
class LOG4CXX_EXPORT Reader : public Object
{
  public:
    DECLARE_ABSTRACT_LOG4CXX_OBJECT(Reader)
    BEGIN_LOG4CXX_CAST_MAP()
    LOG4CXX_CAST_ENTRY(Reader)
    END_LOG4CXX_CAST_MAP()

  protected:
    /**
     * Creates a new character-stream reader.
     */
    Reader();

    virtual ~Reader();

  public:
    /**
     * Closes the stream.
     * @param p The memory pool associated with the reader.
     */
    virtual void close(Pool& p) = 0;

    /**
     * @return The complete stream contents as a LogString.
     * @param p The memory pool associated with the reader.
     */
    virtual LogString read(Pool& p) = 0;

  private:
    Reader(const Reader&);

    Reader& operator=(const Reader&);
};

LOG4CXX_PTR_DEF(Reader);
} // namespace helpers

}  //namespace log4cxx

#endif //_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		/**
51		* Closes the stream.
52		* @param p The memory pool associated with the reader.
53		*/
54		virtual void close(Pool& p) = 0;
55
56		/**
57		* @return The complete stream contents as a LogString.
58		* @param p The memory pool associated with the reader.
59		*/
60		virtual LogString read(Pool& p) = 0;
61
62		private:
63		Reader(const Reader&);
64
65		Reader& operator=(const Reader&);
66		};
67
68		LOG4CXX_PTR_DEF(Reader);
69		} // namespace helpers
70
71		} //namespace log4cxx
72
73		#endif //_LOG4CXX_HELPERS_READER_H

Coverage Report

Created: 2026-01-17 07:13