com.speedment.common.codegen.model.trait.HasSupertype 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.common.codegen.model.trait;

import java.lang.reflect.Type;
import java.util.Optional;

import static com.speedment.common.codegen.constant.DefaultType.genericType;

/**
 * A trait for models that has a super type.
 *
 * @param   the extending type
 *
 * @author Emil Forslund
 * @since  2.0
 */
public interface HasSupertype> {
    
    /**
     * Sets the super type of this model.
     * 
     * @param type  the super type
     * @return      a reference to this
     */
	T setSupertype(Type type);

    /**
     * Sets the super type of this model. This is a synonym for
     * {@link #setSupertype(Type)}.
     *
     * @param supertype  the super type
     * @return           a reference to this
     *
     * @since 2.5
     */
	default T extend(Type supertype) {
	    return setSupertype(supertype);
    }

    /**
     * Sets the super type of this model to a parameterized type created with
     * the specified base type and generic parameters.
     *
     * @param supertype  the supertype
     * @param params     the generic types of that supertype
     * @return           a reference to this
     *
     * @since 2.5
     */
    default T extend(Type supertype, Type... params) {
        return setSupertype(genericType(supertype, params));
    }

    /**
     * Sets the super type of this model to a parameterized type created with
     * the specified base type and generic parameters.
     *
     * @param supertype  the supertype
     * @param params     the generic types of that supertype
     * @return           a reference to this
     *
     * @since 2.5
     */
    default T extend(Type supertype, String... params) {
        return setSupertype(genericType(supertype, params));
    }
    
    /**
     * Returns the super type if such exists, else empty.
     * 
     * @return  the super type or empty
     */
	Optional getSupertype();
}