/*
 * Copyright 2014, Stratio.
 *
 * 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.stratio.cassandra.index.query.builder;

import com.stratio.cassandra.index.query.SortField;

/**
 * {@link Builder} for building a new {@link SortField}.
 *
 * @author Andres de la Pena <adelapena@stratio.com>
 */
public class SortFieldBuilder implements Builder<SortField> {

    /** The name of the field to be used for sort. */
    private final String field;

    /** If natural order should be reversed. */
    private boolean reverse;

    /**
     * Creates a new {@link SortFieldBuilder} for the specified field and reverse option.
     *
     * @param field The name of the field to be used for sort.
     */
    public SortFieldBuilder(String field) {
        this.field = field;
        this.reverse = SortField.DEFAULT_REVERSE;
    }

    /**
     * Returns this {@link SortFieldBuilder} with the specified reverse option.
     *
     * @param reverse {@code true} if natural order should be reversed.
     */
    public SortFieldBuilder reverse(boolean reverse) {
        this.reverse = reverse;
        return this;
    }

    /** {@inheritDoc} */
    @Override
    public SortField build() {
        return new SortField(field, reverse);
    }
}