org.immutables.criteria.matcher.OrderMatcher Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019 Immutables Authors and Contributors
 *
 * 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.immutables.criteria.matcher;

import org.immutables.criteria.expression.Collation;
import org.immutables.criteria.expression.Ordering;

/**
 * Sorting / Order definition.
 */
public interface OrderMatcher extends Matcher {

  /**
   * Sort current expression in ascending order.
   */
  default Ordering asc() {
    return Collation.of(Matchers.extract(this).path(), Ordering.Direction.ASCENDING);
  }

  /**
   * Sort current expression in descending order.
   */
  default Ordering desc() {
    return Collation.of(Matchers.extract(this).path(), Ordering.Direction.DESCENDING);
  }

}