org.jooq.SortOrder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jooq Show documentation
The newest version!
/*
 * 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
 *
 *  https://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.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * Apache-2.0 license and offer limited warranties, support, maintenance, and
 * commercial database integrations.
 *
 * For more information, please visit: https://www.jooq.org/legal/licensing
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

package org.jooq;

import org.jooq.impl.DSL;

import org.jetbrains.annotations.NotNull;

/**
 * The sorting order used in ORDER BY clauses.
 *
 * @author Lukas Eder
 */
public enum SortOrder {

    /**
     * Ascending sort order.
     */
    @NotNull
    @Support
    ASC("asc"),

    /**
     * Descending sort order.
     */
    @NotNull
    @Support
    DESC("desc"),

    /**
     * Default sort order.
     */
    @NotNull
    @Support
    DEFAULT("");

    private final String  sql;
    private final Keyword keyword;

    private SortOrder(String sql) {
        this.sql = sql;
        this.keyword = DSL.keyword(sql);
    }

    @NotNull
    public final String toSQL() {
        return sql;
    }

    @NotNull
    public final Keyword toKeyword() {
        return keyword;
    }
}