/*
 * Copyright 2017 Google LLC
 *
 * 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.
 */

package com.google.cloud.firestore;

import com.google.api.core.ApiFuture;
import java.util.List;
import javax.annotation.Nonnull;

/**
 * A Firestore WriteBatch that can be used to atomically commit multiple write operations at once.
 *
 * @see Firestore#batch()
 */
public class WriteBatch extends UpdateBuilder<WriteBatch> {

  WriteBatch(FirestoreImpl firestore) {
    super(firestore);
  }

  /**
   * Applies the current WriteBatch and returns an array with WriteResults.
   *
   * @return ApiFuture with a List of WriteResults
   */
  @Nonnull
  public ApiFuture<List<WriteResult>> commit() {
    return super.commit(null);
  }
}
