Apache Log4cxx  Version 1.8.0
log4cxx::helpers::InputStreamReader Class Reference

Class for reading from character streams. More...

#include <inputstreamreader.h>

Inheritance diagram for log4cxx::helpers::InputStreamReader:
log4cxx::helpers::Reader log4cxx::helpers::Object

Public Member Functions

 InputStreamReader (const InputStreamPtr &in)
 Creates an InputStreamReader that uses the default charset. More...
 
 InputStreamReader (const InputStreamPtr &in, const CharsetDecoderPtr &enc)
 Creates an InputStreamReader that uses the given charset decoder. More...
 
 ~InputStreamReader ()
 
void close (helpers::Pool &p) override
 Close the stream. More...
 
LogString read (helpers::Pool &p) override
 
LogString getEncoding () const
 
void close ()
 Closes the stream. More...
 
virtual void close (Pool &p)=0
 
LogString read ()
 
virtual LogString read (Pool &p)=0
 
- Public Member Functions inherited from log4cxx::helpers::Reader
void close ()
 Closes the stream. More...
 
LogString read ()
 
- Public Member Functions inherited from log4cxx::helpers::Object
virtual ~Object ()
 
virtual const helpers::ClassgetClass () const =0
 
virtual bool instanceof (const Class &clazz) const =0
 
virtual const void * cast (const Class &clazz) const =0
 

Additional Inherited Members

- Protected Member Functions inherited from log4cxx::helpers::Reader
 Reader ()
 Creates a new character-stream reader. More...
 
virtual ~Reader ()
 

Detailed Description

Class for reading from character streams.

Decorates a byte based InputStream and provides appropriate conversion to characters.

Constructor & Destructor Documentation

◆ InputStreamReader() [1/2]

log4cxx::helpers::InputStreamReader::InputStreamReader ( const InputStreamPtr &  in)

Creates an InputStreamReader that uses the default charset.

Parameters
inThe input stream to decorate.

◆ InputStreamReader() [2/2]

log4cxx::helpers::InputStreamReader::InputStreamReader ( const InputStreamPtr &  in,
const CharsetDecoderPtr &  enc 
)

Creates an InputStreamReader that uses the given charset decoder.

Parameters
inThe input stream to decorate.
encThe charset decoder to use for the conversion.

◆ ~InputStreamReader()

log4cxx::helpers::InputStreamReader::~InputStreamReader ( )

Member Function Documentation

◆ close() [1/3]

void log4cxx::helpers::Reader::close

Closes the stream.

◆ close() [2/3]

void log4cxx::helpers::InputStreamReader::close ( helpers::Pool p)
overridevirtual

Close the stream.

Implements log4cxx::helpers::Reader.

◆ close() [3/3]

virtual void log4cxx::helpers::Reader::close
Deprecated:
The pool parameter is not used and will be removed in a future version.

Implement this method for now, but plan to migrate to close() without a helpers::Pool parameter.

◆ getEncoding()

LogString log4cxx::helpers::InputStreamReader::getEncoding ( ) const
Returns
The name of the character encoding being used by this stream.

◆ read() [1/3]

LogString log4cxx::helpers::Reader::read
Returns
The complete stream contents as a LogString.

◆ read() [2/3]

LogString log4cxx::helpers::InputStreamReader::read ( helpers::Pool p)
overridevirtual
Returns
The complete stream contents as a LogString.

Implements log4cxx::helpers::Reader.

◆ read() [3/3]

virtual LogString log4cxx::helpers::Reader::read
Deprecated:
The pool parameter is not used and will be removed in a future version.

Implement this method for now, but plan to migrate to read() without a helpers::Pool parameter.


The documentation for this class was generated from the following file: