Syndication::SpecificDocument Class Reference

Document interface for format-specific feed documents as parsed from a document source (see DocumentSource). More...

#include <specificdocument.h>

List of all members.

Public Member Functions

virtual ~SpecificDocument ()
virtual bool accept (DocumentVisitor *visitor)=0
virtual QString debugInfo () const =0
virtual bool isValid () const =0

Detailed Description

Document interface for format-specific feed documents as parsed from a document source (see DocumentSource).

The Document classes from the several syndication formats must implement this interface. It's main purpose is to provide access for document visitors (see DocumentVisitor). Usually it is not necessary to access the format-specific document at all, use Feed for a format-agnostic interface to all feed documents supported by the library.

Author:
Frank Osterfeld

Definition at line 52 of file specificdocument.h.


Constructor & Destructor Documentation

Syndication::SpecificDocument::~SpecificDocument (  )  [virtual]

virtual dtor

Definition at line 27 of file specificdocument.cpp.


Member Function Documentation

virtual bool Syndication::SpecificDocument::accept ( DocumentVisitor visitor  )  [pure virtual]

This must be implemented for the double dispatch technique (Visitor pattern).

The usual implementation is

 return visitor->visit(this);

See also DocumentVisitor.

Parameters:
visitor the visitor "visiting" this object
virtual QString Syndication::SpecificDocument::debugInfo (  )  const [pure virtual]

Returns a description of the document for debugging purposes.

Returns:
debug string
virtual bool Syndication::SpecificDocument::isValid (  )  const [pure virtual]

Returns whether this document is valid or not.

Invalid documents do not contain any useful information.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys