org.mongodb.morphia.query.ArraySlice Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of morphia Show documentation

Java Object Document Mapper for MongoDB

The newest version!

/*
 * Copyright (c) 2008-2016 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 org.mongodb.morphia.query;

import com.mongodb.BasicDBObject;
import com.mongodb.DBObject;

import java.util.Arrays;

/**
 * Defines array slicing options for query projections.
 * @mongodb.driver.manual /reference/operator/projection/slice/ $slice
 */
public class ArraySlice {
    private Integer limit;
    private Integer skip;

    /**
     * Specifies the number of array elements to return
     *
     * @param limit the number of array elements to return
     */
    public ArraySlice(final int limit) {
        this.limit = limit;
    }

    /**
     * Specifies the number of array elements to skip.
     *
     * @param skip the number of array elements to skip
     * @param limit the number of array elements to return
     */
    public ArraySlice(final int skip, final int limit) {
        this.skip = skip;
        this.limit = limit;
    }

    /**
     * @return the limit to apply to the projection
     */
    public Integer getLimit() {
        return limit;
    }

    /**
     * @return the skip value to apply to the projection
     */
    public Integer getSkip() {
        return skip;
    }

    DBObject toDatabase() {
        return
            new BasicDBObject("$slice", skip == null ? limit : Arrays.asList(skip, limit));

    }
}