com.mongodb.client.gridfs.model.GridFSDownloadByNameOptions Maven / Gradle / Ivy
/*
* 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.gridfs.model;
/**
* The GridFS download by name options
*
* Controls the selection of the revision to download
*
* @since 3.1
* @deprecated use {@link GridFSDownloadOptions} instead.
*/
@Deprecated
public final class GridFSDownloadByNameOptions {
private int revision;
/**
* Download the most recent version of the file.
*
* Defaults to the most recent revision.
*/
public GridFSDownloadByNameOptions() {
revision = -1;
}
/**
* Set the revision of the file to retrieve.
*
* Revision numbers are defined as follows:
*
* - 0 = the original stored file
* - 1 = the first revision
* - 2 = the second revision
* - etc..
* - -2 = the second most recent revision
* - -1 = the most recent revision
*
*
*
* @param revision the file revision to download
* @return this
*/
public GridFSDownloadByNameOptions revision(final int revision) {
this.revision = revision;
return this;
}
/**
* Gets the revision to download identifier
*
* @return the revision to download identifier
*/
public int getRevision() {
return revision;
}
}