com.mastfrog.asyncpromises.mongo.FindOneAndUpdateBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mongo-promises Show documentation
There is a newer version: 2.9.7
/*
 * The MIT License
 *
 * Copyright 2015 Tim Boudreau.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.mastfrog.asyncpromises.mongo;

import com.mastfrog.asyncpromises.AsyncPromise;
import com.mongodb.client.model.ReturnDocument;
import java.util.concurrent.TimeUnit;
import org.bson.conversions.Bson;

/**
 *
 * @author Tim Boudreau
 */
public interface FindOneAndUpdateBuilder {

    /**
     * Build the promise.
     *
     * @return The promise
     */
    AsyncPromise build();

    /**
     * Set the maximum time to run before failure.
     *
     * @param maxTime The maximum time
     * @param timeUnit The units
     * @return this
     */
    FindOneAndUpdateBuilder maxTime(long maxTime, TimeUnit timeUnit);

    /**
     * Set the projection as a raw BSON object
     *
     * @param projection The projection
     * @return this
     */
    FindOneAndUpdateBuilder projection(Bson projection);

    /**
     * Set the projection using a builder.
     *
     * @return this
     */
    ProjectionBuilder> projection();

    /**
     * Set which document should be returned, the modified one or the original.
     *
     * @param returnDocument Which document should be returned
     * @return this
     */
    FindOneAndUpdateBuilder returnDocument(ReturnDocument returnDocument);

    /**
     * Set the sort criteria when querying.
     *
     * @param sort The sort criteria
     * @return this
     */
    FindOneAndUpdateBuilder sort(Bson sort);

    /**
     * Set whether or not to do an upsert.
     *
     * @param upsert Whether or not to upsert
     * @return this
     */
    FindOneAndUpdateBuilder upsert(boolean upsert);

    /**
     * Set this builder to perform an upsert if necessary.
     *
     * @return this
     */
    FindOneAndUpdateBuilder upsert();
}