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_INTERNAL_API_PUBLIC_READ_NODE_H_ | 5 #ifndef SYNC_INTERNAL_API_PUBLIC_READ_NODE_H_ |
6 #define SYNC_INTERNAL_API_PUBLIC_READ_NODE_H_ | 6 #define SYNC_INTERNAL_API_PUBLIC_READ_NODE_H_ |
7 | 7 |
8 #include <string> | 8 #include <string> |
9 | 9 |
10 #include "base/basictypes.h" | 10 #include "base/basictypes.h" |
11 #include "base/compiler_specific.h" | 11 #include "base/compiler_specific.h" |
12 #include "sync/base/sync_export.h" | 12 #include "sync/base/sync_export.h" |
13 #include "sync/internal_api/public/base/model_type.h" | 13 #include "sync/internal_api/public/base/model_type.h" |
14 #include "sync/internal_api/public/base_node.h" | 14 #include "sync/internal_api/public/base_node.h" |
15 | 15 |
16 namespace syncer { | 16 namespace syncer { |
17 | 17 |
18 // ReadNode wraps a syncable::Entry to provide the functionality of a | 18 // ReadNode wraps a syncable::Entry to provide the functionality of a |
19 // read-only BaseNode. | 19 // read-only BaseNode. |
20 class SYNC_EXPORT ReadNode : public BaseNode { | 20 class SYNC_EXPORT ReadNode : public BaseNode { |
21 public: | 21 public: |
22 // Create an unpopulated ReadNode on the given transaction. Call some flavor | 22 // Create an unpopulated ReadNode on the given transaction. Call some flavor |
23 // of Init to populate the ReadNode with a database entry. | 23 // of Init to populate the ReadNode with a database entry. |
24 explicit ReadNode(const BaseTransaction* transaction); | 24 explicit ReadNode(const BaseTransaction* transaction); |
25 virtual ~ReadNode(); | 25 ~ReadNode() override; |
26 | 26 |
27 // A client must use one (and only one) of the following Init variants to | 27 // A client must use one (and only one) of the following Init variants to |
28 // populate the node. | 28 // populate the node. |
29 | 29 |
30 // BaseNode implementation. | 30 // BaseNode implementation. |
31 virtual InitByLookupResult InitByIdLookup(int64 id) override; | 31 InitByLookupResult InitByIdLookup(int64 id) override; |
32 virtual InitByLookupResult InitByClientTagLookup( | 32 InitByLookupResult InitByClientTagLookup(ModelType model_type, |
33 ModelType model_type, | 33 const std::string& tag) override; |
34 const std::string& tag) override; | |
35 | 34 |
36 // There is always a root node, so this can't fail. The root node is | 35 // There is always a root node, so this can't fail. The root node is |
37 // never mutable, so root lookup is only possible on a ReadNode. | 36 // never mutable, so root lookup is only possible on a ReadNode. |
38 void InitByRootLookup(); | 37 void InitByRootLookup(); |
39 | 38 |
40 // Returns the type root node, if it exists. This is usually created by the | 39 // Returns the type root node, if it exists. This is usually created by the |
41 // server during first sync. Eventually, we plan to remove support for it | 40 // server during first sync. Eventually, we plan to remove support for it |
42 // from the protocol and have the client create the node instead. | 41 // from the protocol and have the client create the node instead. |
43 InitByLookupResult InitTypeRoot(ModelType type); | 42 InitByLookupResult InitTypeRoot(ModelType type); |
44 | 43 |
45 // Returns a server-created and unique-server-tagged item. | 44 // Returns a server-created and unique-server-tagged item. |
46 // | 45 // |
47 // This functionality is only useful for bookmarks because only bookmarks | 46 // This functionality is only useful for bookmarks because only bookmarks |
48 // have server-tagged items. All other server-tagged items are type root | 47 // have server-tagged items. All other server-tagged items are type root |
49 // nodes, which should be looked up with InitTypeRoot(). | 48 // nodes, which should be looked up with InitTypeRoot(). |
50 InitByLookupResult InitByTagLookupForBookmarks(const std::string& tag); | 49 InitByLookupResult InitByTagLookupForBookmarks(const std::string& tag); |
51 | 50 |
52 // Implementation of BaseNode's abstract virtual accessors. | 51 // Implementation of BaseNode's abstract virtual accessors. |
53 virtual const syncable::Entry* GetEntry() const override; | 52 const syncable::Entry* GetEntry() const override; |
54 virtual const BaseTransaction* GetTransaction() const override; | 53 const BaseTransaction* GetTransaction() const override; |
55 | 54 |
56 protected: | 55 protected: |
57 ReadNode(); | 56 ReadNode(); |
58 | 57 |
59 private: | 58 private: |
60 void* operator new(size_t size); // Node is meant for stack use only. | 59 void* operator new(size_t size); // Node is meant for stack use only. |
61 | 60 |
62 // The underlying syncable object which this class wraps. | 61 // The underlying syncable object which this class wraps. |
63 syncable::Entry* entry_; | 62 syncable::Entry* entry_; |
64 | 63 |
65 // The sync API transaction that is the parent of this node. | 64 // The sync API transaction that is the parent of this node. |
66 const BaseTransaction* transaction_; | 65 const BaseTransaction* transaction_; |
67 | 66 |
68 DISALLOW_COPY_AND_ASSIGN(ReadNode); | 67 DISALLOW_COPY_AND_ASSIGN(ReadNode); |
69 }; | 68 }; |
70 | 69 |
71 } // namespace syncer | 70 } // namespace syncer |
72 | 71 |
73 #endif // SYNC_INTERNAL_API_PUBLIC_READ_NODE_H_ | 72 #endif // SYNC_INTERNAL_API_PUBLIC_READ_NODE_H_ |
OLD | NEW |