OLD | NEW |
1 // Copyright 2012 The Chromium Authors. All rights reserved. | 1 // Copyright 2012 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef SYNC_API_SYNC_CHANGE_H_ | 5 #ifndef COMPONENTS_SYNC_API_SYNC_CHANGE_H_ |
6 #define SYNC_API_SYNC_CHANGE_H_ | 6 #define COMPONENTS_SYNC_API_SYNC_CHANGE_H_ |
7 | 7 |
8 #include <iosfwd> | 8 #include <iosfwd> |
9 #include <string> | 9 #include <string> |
10 #include <vector> | 10 #include <vector> |
11 | 11 |
12 #include "base/location.h" | 12 #include "base/location.h" |
13 #include "sync/api/sync_data.h" | 13 #include "components/sync/api/sync_data.h" |
14 #include "sync/base/sync_export.h" | 14 #include "components/sync/base/sync_export.h" |
15 | 15 |
16 namespace syncer { | 16 namespace syncer { |
17 | 17 |
18 // A SyncChange object reflects a change to a piece of synced data. The change | 18 // A SyncChange object reflects a change to a piece of synced data. The change |
19 // can be either a delete, add, or an update. All data relevant to the change | 19 // can be either a delete, add, or an update. All data relevant to the change |
20 // is encapsulated within the SyncChange, which, once created, is immutable. | 20 // is encapsulated within the SyncChange, which, once created, is immutable. |
21 // Note: it is safe and cheap to pass these by value or make copies, as they do | 21 // Note: it is safe and cheap to pass these by value or make copies, as they do |
22 // not create deep copies of their internal data. | 22 // not create deep copies of their internal data. |
23 class SYNC_EXPORT SyncChange { | 23 class SYNC_EXPORT SyncChange { |
24 public: | 24 public: |
25 enum SyncChangeType { | 25 enum SyncChangeType { |
26 ACTION_INVALID, | 26 ACTION_INVALID, |
27 ACTION_ADD, | 27 ACTION_ADD, |
28 ACTION_UPDATE, | 28 ACTION_UPDATE, |
29 ACTION_DELETE, | 29 ACTION_DELETE, |
30 }; | 30 }; |
31 | 31 |
32 // Default constructor creates an invalid change. | 32 // Default constructor creates an invalid change. |
33 SyncChange(); | 33 SyncChange(); |
34 // Create a new change with the specified sync data. | 34 // Create a new change with the specified sync data. |
35 SyncChange( | 35 SyncChange(const tracked_objects::Location& from_here, |
36 const tracked_objects::Location& from_here, | 36 SyncChangeType change_type, |
37 SyncChangeType change_type, | 37 const SyncData& sync_data); |
38 const SyncData& sync_data); | |
39 ~SyncChange(); | 38 ~SyncChange(); |
40 | 39 |
41 // Copy constructor and assignment operator welcome. | 40 // Copy constructor and assignment operator welcome. |
42 | 41 |
43 // Whether this change is valid. This must be true before attempting to access | 42 // Whether this change is valid. This must be true before attempting to access |
44 // the data. | 43 // the data. |
45 // Deletes: Requires valid tag when going to the syncer. Requires valid | 44 // Deletes: Requires valid tag when going to the syncer. Requires valid |
46 // specifics when coming from the syncer. | 45 // specifics when coming from the syncer. |
47 // Adds, Updates: Require valid tag and specifics when going to the syncer. | 46 // Adds, Updates: Require valid tag and specifics when going to the syncer. |
48 // Require only valid specifics when coming from the syncer. | 47 // Require only valid specifics when coming from the syncer. |
(...skipping 19 matching lines...) Expand all Loading... |
68 // An immutable container for the data of this SyncChange. Whenever | 67 // An immutable container for the data of this SyncChange. Whenever |
69 // SyncChanges are copied, they copy references to this data. | 68 // SyncChanges are copied, they copy references to this data. |
70 SyncData sync_data_; | 69 SyncData sync_data_; |
71 }; | 70 }; |
72 | 71 |
73 // gmock printer helper. | 72 // gmock printer helper. |
74 SYNC_EXPORT void PrintTo(const SyncChange& sync_change, std::ostream* os); | 73 SYNC_EXPORT void PrintTo(const SyncChange& sync_change, std::ostream* os); |
75 | 74 |
76 } // namespace syncer | 75 } // namespace syncer |
77 | 76 |
78 #endif // SYNC_API_SYNC_CHANGE_H_ | 77 #endif // COMPONENTS_SYNC_API_SYNC_CHANGE_H_ |
OLD | NEW |