1 /*
2 * Copyright 2019-2026 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.bremersee.comparator.spring.web;
18
19 import java.lang.annotation.Documented;
20 import java.lang.annotation.ElementType;
21 import java.lang.annotation.Retention;
22 import java.lang.annotation.RetentionPolicy;
23 import java.lang.annotation.Target;
24 import org.springframework.web.bind.annotation.ValueConstants;
25
26 /**
27 * The sort order request parameter.
28 *
29 * @author Christian Bremer
30 */
31 @Target(ElementType.PARAMETER)
32 @Retention(RetentionPolicy.RUNTIME)
33 @Documented
34 public @interface SortOrderRequestParam {
35
36 /**
37 * The name of the request parameter. Default is {@code sort}.
38 *
39 * @return the name of the request parameter
40 */
41 String name() default "sort";
42
43 /**
44 * The default sort order.
45 *
46 * @return the default sort order
47 */
48 String defaultSort() default ValueConstants.DEFAULT_NONE;
49
50 }