com.speedment.runtime.config.Column Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tool-deploy Show documentation

A Speedment bundle that shades all dependencies into one jar. This is useful when deploying an application on a server.

The newest version!

/*
 *
 * Copyright (c) 2006-2019, Speedment, Inc. 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.
 */
package com.speedment.runtime.config;

import com.speedment.runtime.config.internal.ColumnImpl;
import com.speedment.runtime.config.mutator.ColumnMutator;
import com.speedment.runtime.config.mutator.DocumentMutator;
import com.speedment.runtime.config.trait.*;
import com.speedment.runtime.config.util.DocumentUtil;

/**
 * A typed {@link Document} that represents a column in the database. A
 * {@code Column} is located inside a {@link Table}.
 *
 * @author  Emil Forslund
 * @since   2.0.0
 */
public interface Column extends
        Document,
        HasParent,
        HasEnabled,
        HasDeepCopy,
        HasId,
        HasName,
        HasAlias,
        HasNullable,
        HasOrdinalPosition,
        HasTypeMapper,
        HasDecimalDigits,
        HasColumnSize,
        HasMainInterface,
        HasEnumConstants,
        HasMutator> {

    /**
     * Returns whether or not this column will auto increment when new values
     * are added to the table.
     *
     * @return  {@code true} if the column auto increments, else {@code false}
     */
    default boolean isAutoIncrement() {
        return getAsBoolean(ColumnUtil.AUTO_INCREMENT).orElse(false);
    }

    @Override
    default Class mainInterface() {
        return Column.class;
    }

    @Override
    default ColumnMutator mutator() {
        return DocumentMutator.of(this);
    }

    @Override
    default Column deepCopy() {
        return DocumentUtil.deepCopy(this, ColumnImpl::new);
    }
} 













© 2015 - 2024 Weber Informatics LLC | Privacy Policy