com.mongodb.client.model.BucketOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mongo-java-driver Show documentation

The MongoDB Java Driver uber-artifact, containing mongodb-driver, mongodb-driver-core, and bson

There is a newer version: 3.12.14

/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * 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.mongodb.client.model;

import com.mongodb.lang.Nullable;

import java.util.ArrayList;
import java.util.List;

import static java.util.Arrays.asList;

/**
 * The options for a $bucket aggregation pipeline stage
 *
 * @mongodb.driver.manual reference/operator/aggregation/bucketAuto/ $bucket
 * @mongodb.server.release 3.4
 * @since 3.4
 */
public class BucketOptions {
    private Object defaultBucket;
    private List output;

    /**
     * The name of the default bucket for values outside the defined buckets
     *
     * @param name the bucket value
     * @return this
     */
    public BucketOptions defaultBucket(@Nullable final Object name) {
        defaultBucket = name;
        return this;
    }

    /**
     * @return the default bucket value
     */
    @Nullable
    public Object getDefaultBucket() {
        return defaultBucket;
    }

    /**
     * @return the output document definition
     */
    @Nullable
    public List getOutput() {
        return output == null ? null : new ArrayList(output);
    }

    /**
     * The definition of the output document in each bucket
     *
     * @param output the output document definition
     * @return this
     */
    public BucketOptions output(final BsonField... output) {
        this.output = asList(output);
        return this;
    }

    /**
     * The definition of the output document in each bucket
     *
     * @param output the output document definition
     * @return this
     */
    public BucketOptions output(final List output) {
        this.output = output;
        return this;
    }

    @Override
    public String toString() {
        return "BucketOptions{"
                + "defaultBucket=" + defaultBucket
                + ", output=" + output
                + '}';
    }
}