com.blazebit.persistence.spring.data.rest.KeysetConfig Maven / Gradle / Ivy
/*
* Copyright 2014 - 2018 Blazebit.
*
* 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.blazebit.persistence.spring.data.rest;
import com.blazebit.persistence.spring.data.repository.KeysetPageable;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Required configuration for a {@link KeysetPageable} that specifies the keyset element type.
*
* @author Christian Beikov
* @since 1.2.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface KeysetConfig {
/**
* The keyset element type. Usually the entity type or the DTO type representing the result element type.
*
* @return The keyset element type.
*/
Class value() default void.class;
/**
* Alias for {@link #value()}.
*
* @return The keyset element type
*/
Class keysetClass() default void.class;
/**
* The query parameter name for the previous page parameter.
*
* @return The previous page query parameter name
*/
String previousPageName() default "";
/**
* The query parameter name for the previous page size parameter.
*
* @return The previous page size query parameter name
*/
String previousPageSizeName() default "";
/**
* The query parameter name for the lowest keyset parameter.
*
* @return The lowest keyset query parameter name
*/
String lowestName() default "";
/**
* The query parameter name for the highest keyset parameter.
*
* @return The highest keyset query parameter name
*/
String highestName() default "";
}