com.mongodb.reactivestreams.client.gridfs.GridFSBuckets Maven / Gradle / Ivy

Go to download

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

A Reactive Streams implementation of the MongoDB Java driver

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.reactivestreams.client.gridfs;

import com.mongodb.reactivestreams.client.MongoDatabase;
import com.mongodb.reactivestreams.client.internal.MongoDatabaseImpl;
import com.mongodb.reactivestreams.client.internal.gridfs.GridFSBucketImpl;

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

/**
 * A factory for GridFSBucket instances.
 *
 * Requires the concrete {@link MongoDatabaseImpl} implementation of the MongoDatabase interface.
 *
 * @since 1.3
 */
public final class GridFSBuckets {

    /**
     * Create a new GridFS bucket with the default {@code 'fs'} bucket name
     *
     * Requires the concrete {@link MongoDatabaseImpl} implementation of the MongoDatabase interface.
     *
     * @param database the database instance to use with GridFS.
     * @return the GridFSBucket
     */
    public static GridFSBucket create(final MongoDatabase database) {
        notNull("database", database);
        return new GridFSBucketImpl(database);
    }

    /**
     * Create a new GridFS bucket with a custom bucket name
     *
     * Requires the concrete {@link MongoDatabaseImpl} implementation of the MongoDatabase interface.
     *
     * @param database   the database instance to use with GridFS
     * @param bucketName the custom bucket name to use
     * @return the GridFSBucket
     */
    public static GridFSBucket create(final MongoDatabase database, final String bucketName) {
        notNull("database", database);
        notNull("bucketName", bucketName);
        return new GridFSBucketImpl(database, bucketName);
    }

    private GridFSBuckets() {
    }
}