com.speedment.runtime.field.IntField 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.field;

import com.speedment.common.annotation.GeneratedCode;
import com.speedment.runtime.compute.ToInt;
import com.speedment.runtime.config.identifier.ColumnIdentifier;
import com.speedment.runtime.field.comparator.IntFieldComparator;
import com.speedment.runtime.field.internal.IntFieldImpl;
import com.speedment.runtime.field.method.IntGetter;
import com.speedment.runtime.field.method.IntSetter;
import com.speedment.runtime.field.trait.HasComparableOperators;
import com.speedment.runtime.field.trait.HasIntValue;
import com.speedment.runtime.typemapper.TypeMapper;

/**
 * A field that represents a primitive {@code int} value.
 * 
 * Generated by com.speedment.sources.pattern.FieldPattern.
 * 
 * @param  entity type
 * @param       database type
 * 
 * @author Emil Forslund
 * @since  3.0.0
 */
@GeneratedCode(value = "Speedment")
public interface IntField extends Field, HasIntValue, HasComparableOperators, ToInt, IntFieldComparator {
    
    /**
     * Creates a new {@link IntField} using the default implementation.
     * 
     * @param    entity type
     * @param         database type
     * @param identifier column that this field represents
     * @param getter     method reference to getter in entity
     * @param setter     method reference to setter in entity
     * @param typeMapper type mapper that is applied
     * @param unique     if column only contains unique values
     * @return           the created field
     */
    static  IntField create(
    ColumnIdentifier identifier,
            IntGetter getter,
            IntSetter setter,
            TypeMapper typeMapper,
            boolean unique) {
        return new IntFieldImpl<>(
            identifier, getter, setter, typeMapper, unique
        );
    }
    
    @Override
    IntField tableAlias(String tableAlias);
    
    @Override
    default int applyAsInt(ENTITY entity) {
        return getAsInt(entity);
    }
    
    @Override
    IntFieldComparator comparator();
    
    @Override
    default IntFieldComparator reversed() {
        return comparator().reversed();
    }
    
    @Override
    default IntField getField() {
        return this;
    }
}