com.speedment.runtime.config.Column Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of runtime-deploy Show documentation
Show all versions of runtime-deploy Show documentation
A Speedment bundle that shades all dependencies into one jar. This is
useful when deploying an application on a server.
/**
*
* Copyright (c) 2006-2017, 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.mutator.ColumnMutator;
import com.speedment.runtime.config.mutator.DocumentMutator;
import com.speedment.runtime.config.trait.HasAlias;
import com.speedment.runtime.config.trait.HasColumnSize;
import com.speedment.runtime.config.trait.HasDecimalDigits;
import com.speedment.runtime.config.trait.HasEnabled;
import com.speedment.runtime.config.trait.HasMainInterface;
import com.speedment.runtime.config.trait.HasMutator;
import com.speedment.runtime.config.trait.HasName;
import com.speedment.runtime.config.trait.HasNullable;
import com.speedment.runtime.config.trait.HasOrdinalPosition;
import com.speedment.runtime.config.trait.HasParent;
import com.speedment.runtime.config.trait.HasTypeMapper;
import java.util.Optional;
/**
* 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,
HasName,
HasAlias,
HasNullable,
HasOrdinalPosition,
HasTypeMapper,
HasDecimalDigits,
HasColumnSize,
HasMainInterface,
HasMutator> {
String AUTO_INCREMENT = "autoIncrement",
ENUM_CONSTANTS = "enumConstants";
/**
* Returns whether or not this column will auto increment when new values
* are added to the table.
*
* @return true
if the column auto increments, else
* false
*/
default boolean isAutoIncrement() {
return getAsBoolean(AUTO_INCREMENT).orElse(false);
}
/**
* Returns a comma separated string of the possible values that this column
* may have. If the list of potential values are not constrained, an empty
* optional is returned.
*
* @return list of constant values separated by commas or empty
*/
default Optional getEnumConstants() {
return getAsString(ENUM_CONSTANTS);
}
@Override
default Class mainInterface() {
return Column.class;
}
@Override
default ColumnMutator mutator() {
return DocumentMutator.of(this);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy