From 68f0e2dafbc99df0789be5fd0aa847ae69940363 Mon Sep 17 00:00:00 2001
From: zxu <zxu@google.com>
Date: Fri, 25 May 2018 15:06:19 -0400
Subject: Firestore project: Import of API interfaces. (#1337)

- 198063502 Address comment upstream. by zxu <zxu>
  - 197942352 Fix style upstream and fix destination depot in copybara. by zxu <zxu>
  - 197925542 Fix headers with change from GitHub, see the current diff... by zxu <zxu>
  - 197922012 Implement ListenerRegistration::Remove(). by zxu <zxu>
  - 197713382 Implement more on listener class and implement ListenerRe... by zxu <zxu>
  - 196551381 Implement more on listener class and implement the Docume... by zxu <zxu>
  - 196276752 Implement the SnapshotMetadata with inline methods and (n... by zxu <zxu>
  - 195841793 Implement the wrapper class for callback (EventListener). by zxu <zxu>
  - 194112388 Add Android-Wrapper for DocumentReference's non-callback ... by zxu <zxu>
  - 192445183 Add Android-Wrapper for Firestore's remaining methods. by zxu <zxu>
  - 190986604 Manually import the public portion of by mcg <mcg>
  - 189013767 Add Android-Wrapper for Firestore's method that does not ... by zxu <zxu>
  - 188809445 Import of firebase-ios-sdk from Github. by mcg <mcg>
  - 187049498 Import of firebase-ios-sdk from Github. by mcg <mcg>
  - 184568931 Import of firebase-ios-sdk from Github. by mcg <mcg>

ORIGINAL_AUTHOR=Firebase <firebase-noreply>
PiperOrigin-RevId: 198063502
---
 .../firebase/firestore/collection_reference.h      | 98 ++++++++++++++++++++++
 1 file changed, 98 insertions(+)
 create mode 100644 Firestore/core/include/firebase/firestore/collection_reference.h

(limited to 'Firestore/core/include/firebase/firestore/collection_reference.h')

diff --git a/Firestore/core/include/firebase/firestore/collection_reference.h b/Firestore/core/include/firebase/firestore/collection_reference.h
new file mode 100644
index 0000000..4d47248
--- /dev/null
+++ b/Firestore/core/include/firebase/firestore/collection_reference.h
@@ -0,0 +1,98 @@
+/*
+ * Copyright 2018 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef FIRESTORE_CORE_INCLUDE_FIREBASE_FIRESTORE_COLLECTION_REFERENCE_H_
+#define FIRESTORE_CORE_INCLUDE_FIREBASE_FIRESTORE_COLLECTION_REFERENCE_H_
+
+namespace firebase {
+namespace firestore {
+
+class CollectionReferenceInternal;
+class FirestoreInternal;
+
+/**
+ * A CollectionReference refers to a collection of documents location in a
+ * Firestore database and can be used for adding documents, getting document
+ * references, and querying for documents.
+ */
+// TODO(zxu123): add more methods to complete the class and make it useful.
+class CollectionReference {
+ public:
+  /**
+   * @brief Default constructor. This creates an invalid CollectionReference.
+   * Attempting to perform any operations on this reference will fail unless a
+   * valid CollectionReference has been assigned to it.
+   */
+  CollectionReference();
+
+  /**
+   * @brief Copy constructor. It's totally okay (and efficient) to copy
+   * CollectionReference instances, as they simply point to the same location in
+   * the database.
+   *
+   * @param[in] reference CollectionReference to copy from.
+   */
+  CollectionReference(const CollectionReference& reference);
+
+  /**
+   * @brief Move constructor. Moving is an efficient operation for
+   * CollectionReference instances.
+   *
+   * @param[in] reference CollectionReference to move data from.
+   */
+  CollectionReference(CollectionReference&& reference);
+
+  /** @brief Required virtual destructor. */
+  virtual ~CollectionReference();
+
+  /**
+   * @brief Copy assignment operator. It's totally okay (and efficient) to copy
+   * CollectionReference instances, as they simply point to the same location in
+   * the database.
+   *
+   * @param[in] reference CollectionReference to copy from.
+   *
+   * @returns Reference to the destination CollectionReference.
+   */
+  CollectionReference& operator=(const CollectionReference& reference);
+
+  /**
+   * @brief Move assignment operator. Moving is an efficient operation for
+   * CollectionReference instances.
+   *
+   * @param[in] reference CollectionReference to move data from.
+   *
+   * @returns Reference to the destination CollectionReference.
+   */
+  CollectionReference& operator=(CollectionReference&& reference);
+
+ protected:
+  explicit CollectionReference(CollectionReferenceInternal* internal);
+
+ private:
+  friend class DocumentReference;
+  friend class DocumentReferenceInternal;
+  friend class FirestoreInternal;
+
+  // TODO(zxu123): investigate possibility to use std::unique_ptr or
+  // firebase::UniquePtr.
+  CollectionReferenceInternal* internal_ = nullptr;
+};
+
+}  // namespace firestore
+}  // namespace firebase
+
+#endif  // FIRESTORE_CORE_INCLUDE_FIREBASE_FIRESTORE_COLLECTION_REFERENCE_H_
-- 
cgit v1.2.3