/*
 * Copyright 2019 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_SRC_MODEL_DELETE_MUTATION_H_
#define FIRESTORE_CORE_SRC_MODEL_DELETE_MUTATION_H_

#include <memory>
#include <string>
#include <utility>
#include <vector>

#include "Firestore/core/src/model/model_fwd.h"
#include "Firestore/core/src/model/mutation.h"

namespace firebase {
namespace firestore {
namespace model {

/** Represents a Delete operation. */
class DeleteMutation : public Mutation {
 public:
  DeleteMutation(DocumentKey key, Precondition precondition);

  /**
   * Casts a Mutation to a DeleteMutation. This is a checked operation that will
   * assert if the type of the Mutation isn't actually Type::Delete.
   */
  explicit DeleteMutation(const Mutation& mutation);

  /** Creates an invalid DeleteMutation instance. */
  DeleteMutation() = default;

 private:
  class Rep : public Mutation::Rep {
   public:
    using Mutation::Rep::Rep;

    Type type() const override {
      return Type::Delete;
    }

    void ApplyToRemoteDocument(
        MutableDocument& document,
        const MutationResult& mutation_result) const override;

    absl::optional<FieldMask> ApplyToLocalView(
        MutableDocument& document,
        absl::optional<FieldMask> previous_mask,
        const Timestamp&) const override;

    // Does not override Equals or Hash; Mutation's versions are sufficient.

    std::string ToString() const override;
  };
};

}  // namespace model
}  // namespace firestore
}  // namespace firebase

#endif  // FIRESTORE_CORE_SRC_MODEL_DELETE_MUTATION_H_
