1 /* This file is part of qjson
3 * Copyright (C) 2009 Till Adam <adam@kde.org>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public License
16 * along with this library; see the file COPYING.LIB. If not, write to
17 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 * Boston, MA 02110-1301, USA.
21 #ifndef QJSON_SERIALIZER_H
22 #define QJSON_SERIALIZER_H
24 #include "qjson_export.h"
32 * @brief Main class used to convert QVariant objects to JSON data.
34 * QVariant objects are converted to a string containing the JSON data.
35 * If QVariant object is empty or not valid a <em>null</em> json object is returned.
37 class QJSON_EXPORT Serializer {
43 * This method generates a textual JSON representation and outputs it to the
44 * passed in I/O Device.
45 * @param variant The JSON document in its in-memory representation as generated by the
47 * @param out Input output device
48 * @param ok if a conversion error occurs, *ok is set to false; otherwise *ok is set to true
50 void serialize( const QVariant& variant, QIODevice* out, bool* ok = 0 );
53 * This is a method provided for convenience. It turns the passed in in-memory
54 * representation of the JSON document into a textual one, which is returned.
55 * If the returned string is empty, the document was empty. If it was null, there
56 * was a parsing error.
58 * @param variant The JSON document in its in-memory representation as generated by the
62 QByteArray serialize( const QVariant& variant );
65 Q_DISABLE_COPY(Serializer)
66 class SerializerPrivate;
67 SerializerPrivate* const d;
71 #endif // QJSON_SERIALIZER_H