com.speedment.runtime.field.EnumForeignKeyField Maven / Gradle / Ivy
Show all versions of runtime-deploy Show documentation
/**
*
* 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.field;
import com.speedment.runtime.config.identifier.ColumnIdentifier;
import com.speedment.runtime.field.internal.EnumForeignKeyFieldImpl;
import com.speedment.runtime.field.method.ReferenceGetter;
import com.speedment.runtime.field.method.ReferenceSetter;
import com.speedment.runtime.field.trait.HasComparableOperators;
import com.speedment.runtime.field.trait.HasFinder;
import com.speedment.runtime.field.trait.HasNullableFinder;
import com.speedment.runtime.typemapper.TypeMapper;
import java.util.function.Function;
/**
* A field representing an {@code Enum} value in the entity that has a finder to
* another entity.
*
* @param the entity type
* @param the database type
* @param the java enum type
* @param the foreign key entity type
*
* @author Emil Forslund
* @since 3.0.10
*
* @see EnumField
* @see HasFinder
*/
public interface EnumForeignKeyField, FK>
extends EnumField,
HasNullableFinder {
@Override
EnumForeignKeyField tableAlias(String tableAlias);
/**
* A method that takes a {@code String} and converts it into an enum for
* this field.
*
* The function should return {@code null} if a {@code null} value is
* specified as input and throw an exception if the value is invalid.
*
* @return the string-to-enum mapper
*/
@Override
Function stringToEnum();
/**
* A method that takes an enum and converts it into a {@code String}.
*
* The function should return {@code null} if a {@code null} value is
* specified as input and throw an exception if the value is invalid.
*
* @return the enum-to-string mapper
*/
@Override
Function enumToString();
/**
* Create a new instance of this interface using the default implementation.
*
* @param the entity type
* @param the database type
* @param the java enum type
* @param the foreign key entity type
* @param identifier the column that this field represents
* @param getter method reference to the getter in the entity
* @param setter method reference to the setter in the entity
* @param typeMapper the type mapper that is applied
* @param referenced the field in the foreign entity that is referenced
* @param enumToString method to convert enum to a string
* @param stringToEnum method to convert a string to enum
* @param enumClass the enum class
*
* @return the created field
*/
static , FK>
EnumForeignKeyField create(
ColumnIdentifier identifier,
ReferenceGetter getter,
ReferenceSetter setter,
TypeMapper typeMapper,
HasComparableOperators referenced,
Function enumToString,
Function stringToEnum,
Class enumClass) {
return new EnumForeignKeyFieldImpl<>(
identifier, getter, setter, typeMapper, referenced,
enumToString, stringToEnum, enumClass
);
}
}