org.jooq.Key Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hello-world-plugin Show documentation

Kill Bill Hello World plugin

The newest version!

/*
 * 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;

import java.io.Serializable;
import java.util.List;


/**
 * A Key is an object representing a UNIQUE KEY, a
 * PRIMARY KEY, or a FOREIGN KEY.
 *
 * @param  The KEY's owner table record
 * @author Lukas Eder
 */
public interface Key extends Serializable {

    /**
     * The Key's name.
     */
    String getName();

    /**
     * The Key's owner table
     */
    Table getTable();

    /**
     * The fields that make up the KEY
     */
    List> getFields();

    /**
     * The fields that make up the KEY
     *
     * @see #getFields()
     */
    TableField[] getFieldsArray();

    /**
     * Get this KEY as a formal {@link Constraint} specification.
     */
    Constraint constraint();
}