davitem.h

/*
    SPDX-FileCopyrightText: 2009 Grégory Oestreicher <greg@kamago.net>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
*/
 
#ifndef KDAV_DAVITEM_H
#define KDAV_DAVITEM_H
 
#include "kdav_export.h"
 
#include <QByteArray>
#include <QDataStream>
#include <QList>
#include <QSharedDataPointer>
#include <QString>
 
class DavItemPrivate;
 
namespace KDAV
{
class DavUrl;
}
 
namespace KDAV
{
/**
 * @class DavItem davitem.h <KDAV/DavItem>
 *
 * @short A helper class to store information about DAV resources.
 *
 * This class is used as container to transfer information about DAV
 * resources between the Akonadi resource and the DAV jobs.
 *
 * @note While the DAV RFC names them DAV resource we call them items
 *       to comply to Akonadi terminology.
 */
class KDAV_EXPORT DavItem
{
public:
    /**
     * Defines a list of DAV item objects.
     */
    typedef QList<DavItem> List;
 
    /**
     * Creates an empty DAV item.
     */
    DavItem();
 
    /**
     * Creates a new DAV item.
     *
     * @param url The URL that identifies the item.
     * @param contentType The content type of the item.
     * @param data The actual raw content data of the item.
     * @param etag The ETag of the item.
     */
    DavItem(const DavUrl &url, const QString &contentType, const QByteArray &data, const QString &etag);
 
    DavItem(const DavItem &other);
    DavItem(DavItem &&);
    DavItem &operator=(const DavItem &other);
    DavItem &operator=(DavItem &&);
 
    ~DavItem();
 
    /**
     * Sets the @p url that identifies the item.
     */
    void setUrl(const DavUrl &url);
 
    /**
     * Returns the URL that identifies the item.
     */
    Q_REQUIRED_RESULT DavUrl url() const;
 
    /**
     * Sets the content @p type of the item.
     */
    void setContentType(const QString &type);
 
    /**
     * Returns the content type of the item.
     */
    Q_REQUIRED_RESULT QString contentType() const;
 
    /**
     * Sets the raw content @p data of the item.
     */
    void setData(const QByteArray &data);
 
    /**
     * Returns the raw content data of the item.
     */
    Q_REQUIRED_RESULT QByteArray data() const;
 
    /**
     * Sets the @p etag of the item.
     * @see https://tools.ietf.org/html/rfc4918#section-8.6
     */
    void setEtag(const QString &etag);
 
    /**
     * Returns the ETag of the item.
     * @see https://tools.ietf.org/html/rfc4918#section-8.6
     */
    Q_REQUIRED_RESULT QString etag() const;
 
private:
    QSharedDataPointer<DavItemPrivate> d;
};
 
KDAV_EXPORT QDataStream &operator<<(QDataStream &out, const DavItem &item);
KDAV_EXPORT QDataStream &operator>>(QDataStream &in, DavItem &item);
}
 
Q_DECLARE_TYPEINFO(KDAV::DavItem, Q_RELOCATABLE_TYPE);
 
#endif