sync/api/attachments/attachment_metadata.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef SYNC_API_ATTACHMENTS_ATTACHMENT_METADATA_H_
   6 #define SYNC_API_ATTACHMENTS_ATTACHMENT_METADATA_H_
   7
   8 #include <vector>
   9
  10 #include "base/basictypes.h"
  11 #include "sync/api/attachments/attachment_id.h"
  12 #include "sync/base/sync_export.h"
  13
  14 namespace syncer {
  15
  16 // This class represents immutable Attachment metadata.
  17 //
  18 // It is OK to copy and return AttachmentMetadata by value.
  19 class SYNC_EXPORT AttachmentMetadata {
  20  public:
  21   AttachmentMetadata(const AttachmentId& id, size_t size);
  22   ~AttachmentMetadata();
  23
  24   // Default copy and assignment are welcome.
  25
  26   // Returns this attachment's id.
  27   const AttachmentId& GetId() const;
  28
  29   // Returns this attachment's size in bytes.
  30   size_t GetSize() const;
  31
  32  private:
  33   // TODO(maniscalco): Reconcile AttachmentMetadata and
  34   // AttachmentId. AttachmentId knows the size of the attachment so
  35   // AttachmentMetadata may not be necessary (crbug/465375).
  36   AttachmentId id_;
  37   size_t size_;
  38 };
  39
  40 typedef std::vector<syncer::AttachmentMetadata> AttachmentMetadataList;
  41
  42 }  // namespace syncer
  43
  44 #endif  // SYNC_API_ATTACHMENTS_ATTACHMENT_METADATA_H_