org.jooq.util.ColumnDefinition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jooq-meta Show documentation

There is a newer version: 3.19.16

/**
 * Copyright (c) 2009-2016, Data Geekery GmbH (http://www.datageekery.com)
 * All rights reserved.
 *
 * 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.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * ASL 2.0 and offer limited warranties, support, maintenance, and commercial
 * database integrations.
 *
 * For more information, please visit: http://www.jooq.org/licenses
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

package org.jooq.util;

import java.util.List;

/**
 * An interface defining a column of a table.
 *
 * @author Lukas Eder
 */
public interface ColumnDefinition extends TypedElementDefinition {

    /**
     * The column position in the table.
     */
    int getPosition();

    /**
     * A definition for the primary key that this column is part of, or
     * null if this column is not part of a primary key.
     */
    UniqueKeyDefinition getPrimaryKey();

    /**
     * All definitions of unique keys that this column is part of.
     */
    List getUniqueKeys();

    /**
     * All definitions of foreign keys that this column is part of.
     */
    List getForeignKeys();

    /**
     * Whether this column is the table's IDENTITY column.
     */
    boolean isIdentity();

    /**
     * Whether the column is nullable.
     *
     * @deprecated - [#2699] - 3.2.0 - Use
     *             {@link DataTypeDefinition#isNullable()} instead.
     */
    @Deprecated
    boolean isNullable();
}