SqlColumnOrder.java

/*
 * This file is part of NucleusFramework for Bukkit, licensed under the MIT License (MIT).
 *
 * Copyright (c) JCThePants (www.jcwhatever.com)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.jcwhatever.nucleus.providers.sql.statement.generators;

import com.jcwhatever.nucleus.providers.sql.ISqlTable;
import com.jcwhatever.nucleus.providers.sql.SqlOrder;
import com.jcwhatever.nucleus.utils.PreCon;

/**
 * Specifies the desired order of a table column.
 */
public class SqlColumnOrder {

    private final ISqlTable _table;
    private final String _columnName;
    private final SqlOrder _order;

    /**
     * Constructor.
     *
     * @param table       The table the specified column is from.
     * @param columnName  The name of the column.
     * @param order       The column order.
     */
    public SqlColumnOrder(ISqlTable table, String columnName, SqlOrder order) {
        PreCon.notNull(table);
        PreCon.notNullOrEmpty(columnName);
        PreCon.notNull(order);

        _table = table;
        _columnName = columnName;
        _order = order;
    }

    /**
     * Get the table the specified column is from.
     */
    public ISqlTable getTable() {
        return _table;
    }

    /**
     * Get the name of the column to sort by.
     */
    public String getColumnName() {
        return _columnName;
    }

    /**
     * Get the sort ordering of the column.
     */
    public SqlOrder getOrder() {
        return _order;
    }
}