#include <balxml_formatter.h>

Public Member Functions
	Formatter_StreamHolder (bsl::streambuf *streamBuffer)

	Formatter_StreamHolder (bsl::ostream *stream)
	Create a `Formatter_StreamHolder` that holds the specified `stream`.

bsl::ostream *	stream ()

const bsl::ostream *	stream () const

Detailed Description

This component-private class provides a mechanism for holding the bsl::ostream used by the Formatter to emit XML documents. Objects of Formatter_StreamHolder type can be constructed with either a bsl::streambuf * or a bsl::ostream *. If a stream holder is constructed with a bsl::streambuf *, then it owns its held bsl::ostream, which is constructed with the supplied stream buffer. If a stream holder is constructed with a bsl::ostream *, its held bsl::ostream is the supplied stream.

See balxml_formatter

Constructor & Destructor Documentation

◆ Formatter_StreamHolder() [1/2]

balxml::Formatter_StreamHolder::Formatter_StreamHolder ( bsl::streambuf * streamBuffer )

inlineexplicit

Create a Formatter_StreamHolder object that holds a bsl::ostream constructed from the specified streamBuffer.

◆ Formatter_StreamHolder() [2/2]

balxml::Formatter_StreamHolder::Formatter_StreamHolder ( bsl::ostream * stream )

inlineexplicit

Member Function Documentation

◆ stream() [1/2]

bsl::ostream * balxml::Formatter_StreamHolder::stream ( )

inline

Return the address that provides modifiable access to this object's held bsl::ostream.

◆ stream() [2/2]

const bsl::ostream * balxml::Formatter_StreamHolder::stream ( ) const