Xalan-C++ API Reference 1.12.0
Public Member Functions | Static Public Attributes | List of all members
xalanc::Writer Class Referenceabstract

#include <xalanc/PlatformSupport/Writer.hpp>

Inheritance diagram for xalanc::Writer:
[legend]

Public Member Functions

 Writer ()
 
virtual ~Writer ()
 
virtual void close ()=0
 Close the stream.
 
virtual void flush ()=0
 Flush the stream.
 
virtual XalanOutputStreamgetStream ()
 Get the stream associated with the writer...
 
virtual const XalanOutputStreamgetStream () const
 Get the stream associated with the writer...
 
virtual void write (const char *s, size_t theOffset=0, size_t theLength=npos)=0
 Writes a string.
 
virtual void write (const XalanDOMChar *s, XalanDOMString::size_type theOffset=0, XalanDOMString::size_type theLength=XalanDOMString::npos)=0
 Writes a string.
 
virtual void write (XalanDOMChar c)=0
 Writes a character.
 
virtual void write (const XalanDOMString &s, XalanDOMString::size_type theOffset=0, XalanDOMString::size_type theLength=XalanDOMString::npos)=0
 Writes a string.
 

Static Public Attributes

static const size_t npos
 

Detailed Description

Definition at line 44 of file Writer.hpp.

Constructor & Destructor Documentation

◆ Writer()

xalanc::Writer::Writer ( )

◆ ~Writer()

virtual xalanc::Writer::~Writer ( )
virtual

Member Function Documentation

◆ close()

virtual void xalanc::Writer::close ( )
pure virtual

◆ flush()

virtual void xalanc::Writer::flush ( )
pure virtual

◆ getStream() [1/2]

virtual XalanOutputStream * xalanc::Writer::getStream ( )
virtual

Get the stream associated with the writer...

Reimplemented in xalanc::XalanOutputStreamPrintWriter.

◆ getStream() [2/2]

virtual const XalanOutputStream * xalanc::Writer::getStream ( ) const
virtual

Get the stream associated with the writer...

Reimplemented in xalanc::XalanOutputStreamPrintWriter.

◆ write() [1/4]

virtual void xalanc::Writer::write ( const char s,
size_t  theOffset = 0,
size_t  theLength = npos 
)
pure virtual

Writes a string.

Parameters
sstring to write
theOffsetstarting offset in string to begin writing, default 0
theLengthnumber of characters to write. If the length is npos, then the array is assumed to be null-terminated.

Implemented in xalanc::DOMStringPrintWriter, xalanc::NullPrintWriter, xalanc::XalanOutputStreamPrintWriter, and xalanc::PrintWriter.

◆ write() [2/4]

virtual void xalanc::Writer::write ( const XalanDOMChar s,
XalanDOMString::size_type  theOffset = 0,
XalanDOMString::size_type  theLength = XalanDOMString::npos 
)
pure virtual

Writes a string.

Parameters
sstring to write
theOffsetstarting offset in string to begin writing, default 0
theLengthnumber of characters to write. If the length is XalanDOMString::npos, then the array is assumed to be null-terminated.

Implemented in xalanc::DOMStringPrintWriter, xalanc::NullPrintWriter, xalanc::XalanOutputStreamPrintWriter, and xalanc::PrintWriter.

◆ write() [3/4]

virtual void xalanc::Writer::write ( const XalanDOMString s,
XalanDOMString::size_type  theOffset = 0,
XalanDOMString::size_type  theLength = XalanDOMString::npos 
)
pure virtual

Writes a string.

Parameters
sstring to write
theOffsetstarting offset in string to begin writing, default 0
theLengthnumber of characters to write. If the length is XalanDOMString::npos, then the entire string is printed.

Implemented in xalanc::DOMStringPrintWriter, xalanc::NullPrintWriter, xalanc::XalanOutputStreamPrintWriter, and xalanc::PrintWriter.

References xalanc::operator==().

◆ write() [4/4]

virtual void xalanc::Writer::write ( XalanDOMChar  c)
pure virtual

Writes a character.

Parameters
ccharacter to write

Implemented in xalanc::DOMStringPrintWriter, xalanc::NullPrintWriter, xalanc::XalanOutputStreamPrintWriter, and xalanc::PrintWriter.

Member Data Documentation

◆ npos

const size_t xalanc::Writer::npos
static

Definition at line 80 of file Writer.hpp.


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