Format::Formatter Class Referenceabstract

Virtual class to perform format-specific String adjustments. More...

#include <Formatter.h>

Inheritance diagram for Format::Formatter:

Public Member Functions

virtual void escape (String &value) const =0
 Perform any necessary text escaping so output is valid. More...
 
virtual void quote (String &value) const =0
 Convert a value into quoted string. More...
 
virtual void unQuote (String &value) const =0
 Remove any quotes from a value. More...
 
virtual MimeType mimeType () const =0
 Corresponding MIME type for this format. More...
 

Detailed Description

Virtual class to perform format-specific String adjustments.

Member Function Documentation

◆ escape()

virtual void Format::Formatter::escape ( String value) const
pure virtual

Perform any necessary text escaping so output is valid.

Implemented in Format::Html, Format::Json, Format::Standard, and Format::Xml.

◆ mimeType()

virtual MimeType Format::Formatter::mimeType ( ) const
pure virtual

Corresponding MIME type for this format.

Note
New types must be added to WebConstants.h

Implemented in Format::Standard, Format::Html, Format::Json, and Format::Xml.

◆ quote()

virtual void Format::Formatter::quote ( String value) const
pure virtual

Convert a value into quoted string.

Implemented in Format::Standard.

◆ unQuote()

virtual void Format::Formatter::unQuote ( String value) const
pure virtual

Remove any quotes from a value.

Implemented in Format::Standard.


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