Quick Links:

bal | bbl | bdl | bsl

Public Member Functions

balxml::Formatter_StreamHolder Class Reference

#include <balxml_formatter.h>

List of all members.

Public Member Functions

 Formatter_StreamHolder (bsl::streambuf *streamBuffer)
 Formatter_StreamHolder (bsl::ostream *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 Component balxml_formatter


Constructor & Destructor Documentation

balxml::Formatter_StreamHolder::Formatter_StreamHolder ( bsl::streambuf *  streamBuffer  )  [explicit]

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

balxml::Formatter_StreamHolder::Formatter_StreamHolder ( bsl::ostream *  stream  )  [explicit]

Create a Formatter_StreamHolder that holds the specified stream.


Member Function Documentation

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

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

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

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


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