org.jdbi.v3.sqlobject.customizer.MaxRows Maven / Gradle / Ivy

Go to download
/*
 * 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.jdbi.v3.sqlobject.customizer;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.jdbi.v3.sqlobject.customizer.internal.MaxRowsFactory;

/**
 * Used to specify the maximum number of rows to return on a result set. Passes through to
 * setMaxRows on the JDBC prepared statement.
 *
 * This is significantly less efficient than a SQL {@code LIMIT}, be careful!
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.PARAMETER})
@SqlStatementCustomizingAnnotation(MaxRowsFactory.class)
public @interface MaxRows {
    /**
     * The max number of rows to return from the query.
     * @return the max rows
     */
    int value() default MaxRowsFactory.DEFAULT_MAX_ROWS;
}