OrderByExpression.java

/**
 * Copyright (c) 2002-2013 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.neo4j.cypherdsl.query;

import org.neo4j.cypherdsl.Order;
import org.neo4j.cypherdsl.expression.Expression;

/**
 * Provides the possible expressions for the ORDER BY clause.
 */
public class OrderByExpression
        extends AbstractExpression
{
    public final Expression expression;
    public final Order order;

    public OrderByExpression( Expression expression, Order order )
    {
        this.expression = expression;
        this.order = order;
    }

    public OrderByExpression order( Order order )
    {
        return new OrderByExpression( expression, order );
    }

    public void asString( StringBuilder builder )
    {
        expression.asString( builder );
        if ( order != null )
        {
            builder.append( ' ' ).append( order.name() );
        }
    }

    @Override
    public Object clone()
            throws CloneNotSupportedException
    {
        return super.clone();
    }
}