src/CacheJsonToArticleConverter.h

   1 //! \file CacheJsonToArticleConverter.h
   2
   3 #ifndef _CACHEJSONTOARTICLECONVERTER_H
   4 #define _CACHEJSONTOARTICLECONVERTER_H
   5
   6 #include "ArticleCollection.h"
   7
   8 /*! Read Article from JSON cache file.
   9  * This class does the opposite to #ToJsonWriter.
  10  */
  11 class CacheJsonToArticleConverter
  12 {
  13 public:
  14     /*! Convert JSON data from cache file into an article collection.
  15      * \param json JSON data
  16      * \param articleCache Article collection to add articles to. Will
  17      *          also look up existing articles there.
  18      * \returns reference to passed article collection.
  19      */
  20     ArticleCollection& convertToArticle(std::string json,
  21                                         ArticleCollection& articleCache);
  22 };
  23
  24 #endif // _CACHEJSONTOARTICLECONVERTER_H