com.cinchapi.concourse.lang.sort.TransitionToOrderDirectionState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of concourse-driver-java Show documentation

Concourse is a self-tuning database that is designed for both ad hoc analytics and high volume transactions at scale. Developers use Concourse to quickly build mission critical software while also benefiting from real time insight into their most important data. With Concourse, end-to-end data management requires no extra infrastructure, no prior configuration and no additional coding–all of which greatly reduce costs and allow developers to focus on core business problems.

There is a newer version: 0.11.2

Show newest version

/*
 * Copyright (c) 2013-2019 Cinchapi Inc.
 *
 * 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.cinchapi.concourse.lang.sort;

/**
 * A {@link OrderState} that may transition to an {@link OrderDirectionState}.
 *
 * @author Jeff Nelson
 */
interface TransitionToOrderDirectionState {

    /**
     * Add the {@link Direction#ASCENDING} direction to the last key that
     * was specified in {@link BuiltOrder} that is building
     *
     * @return the builder
     */
    public default OrderDirectionState ascending() {
        return new OrderDirectionState($order(), $order().lastKey,
                Direction.ASCENDING);
    }

    /**
     * Alias for {@link #descending()}.
     *
     * @return the builder
     */
    public default OrderDirectionState decreasing() {
        return descending();
    }

    /**
     * Add the {@link Direction#DESCENDING} direction to the last key that
     * was specified in {@link BuiltOrder} that is building
     *
     * @return the builder
     */
    public default OrderDirectionState descending() {
        return new OrderDirectionState($order(), $order().lastKey,
                Direction.DESCENDING);
    }

    /**
     * Alias for {@link #ascending()}.
     *
     * @return the builder
     */
    public default OrderDirectionState increasing() {
        return ascending();
    }

    /**
     * Alias for {@link #descending()}.
     *
     * @return the builder
     */
    public default OrderDirectionState largestFirst() {
        return descending();
    }

    /**
     * Alias for {@link #ascending()}.
     *
     * @return the builder
     */
    public default OrderDirectionState largestLast() {
        return ascending();
    }

    /**
     * Alias for {@link #descending()}.
     *
     * @return the builder
     */
    public default OrderDirectionState reversed() {
        return descending();
    }

    /**
     * Alias for {@link #ascending()}.
     *
     * @return the builder
     */
    public default OrderDirectionState smallestFirst() {
        return ascending();
    }

    /**
     * Alias for {@link #descending()}.
     *
     * @return the builder
     */
    public default OrderDirectionState smallestLast() {
        return descending();
    }

    /**
     * Return the {@link BuiltOrder} that is being constructed.
     * 
     * @return the {@link BuiltOrder}
     */
    public BuiltOrder $order();

}