1 /*
2 * Copyright 2016-2025 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 * https://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 package org.mybatis.dynamic.sql;
17
18 import org.mybatis.dynamic.sql.render.RenderingContext;
19 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
20
21 /**
22 * Defines attributes of columns that are necessary for rendering an order by expression.
23 *
24 * @author Jeff Butler
25 */
26 public interface SortSpecification {
27 /**
28 * Returns a new instance of the SortSpecification that should render as descending in an
29 * ORDER BY clause.
30 *
31 * @return new instance of SortSpecification
32 */
33 SortSpecification descending();
34
35 /**
36 * Return a fragment rendered for use in an ORDER BY clause. The fragment should include "DESC" if a
37 * descending order is desired.
38 *
39 * @param renderingContext the current rendering context
40 * @return a rendered fragment and parameters if applicable
41 * @since 2.0.0
42 */
43 FragmentAndParameters renderForOrderBy(RenderingContext renderingContext);
44 }