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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mongodb-driver-core Show documentation

The Java operations layer for the MongoDB Java Driver. Third parties can wrap this layer to provide custom higher-level APIs

There is a newer version: 5.3.0-beta0

Show newest version

/*
 * 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 org.bson.conversions.Bson;

import static com.mongodb.assertions.Assertions.notNull;

/**
 * Options for cluster index on a collection.
 *
 * @see CreateCollectionOptions
 * @since 4.7
 * @mongodb.server.release 5.3
 */
public class ClusteredIndexOptions {
    private final Bson key;
    private final boolean unique;
    private String name;

    /**
     * Construct an instance with the required options.
     *
     * @param key the index key, which currently must be {@code {_id: 1}}
     * @param unique whether the index entries must be unique, which currently must be true
     */
    public ClusteredIndexOptions(final Bson key, final boolean unique) {
        this.key = notNull("key", key);
        this.unique = unique;
    }

    /**
     * Gets the index key.
     *
     * @return the index key
     */
    public Bson getKey() {
        return key;
    }

    /**
     * Gets whether the index entries must be unique
     * @return whether the index entries must be unique
     */
    public boolean isUnique() {
        return unique;
    }

    /**
     * Gets the index name
     *
     * @return the index name
     */
    @Nullable
    public String getName() {
        return name;
    }

    /**
     * Sets the index name
     * @param name the index name
     * @return this
     */
    public ClusteredIndexOptions name(final String name) {
        this.name = name;
        return this;
    }

    @Override
    public String toString() {
        return "ClusteredIndexOptions{"
                + "key=" + key
                + ", unique=" + unique
                + ", name='" + name + '\''
                + '}';
    }
}