com.mongodb.client.model.Facet 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 org.bson.conversions.Bson;

import java.util.List;

import static java.util.Arrays.asList;

/**
 * Defines a Facet for use in $facet pipeline stages.
 *
 * @mongodb.driver.manual reference/operator/aggregation/facet/ $facet
 * @mongodb.server.release 3.4
 * @since 3.4
 */
public class Facet {
    private final String name;
    private final List pipeline;

    /**
     * @param name     the name of this facet
     * @param pipeline the facet definition pipeline
     */
    public Facet(final String name, final List pipeline) {
        this.name = name;
        this.pipeline = pipeline;
    }

    /**
     * @param name     the name of this facet
     * @param pipeline the facet definition pipeline
     */
    public Facet(final String name, final Bson... pipeline) {
        this(name, asList(pipeline));
    }

    /**
     * @return the facet name
     */
    public String getName() {
        return name;
    }

    /**
     * @return the pipeline definition
     */
    public List getPipeline() {
        return pipeline;
    }

    @Override
    public String toString() {
        return "Facet{"
                + "name='" + name + '\''
                + ", pipeline=" + pipeline
                + '}';
    }
}