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

/**
 * Trait for all models that has a parent. Models that are designed to be reused
 * typically don't have a parent.
 * 
 * If the model implementing this trait also implements {@link HasCopy}, then
 * the parent property will not be copied when {@link HasCopy#copy()}
 * is invoked.
 *
 * @param 
  the model type of the parent
 * @param   the extending type
 *
 * @author Emil Forslund
 * @since  2.5
 */
public interface HasParent> {

    /**
     * Sets the parent of this model. This method should only be invoked by
     * other models when they add a new child, it should not be invoked
     * directly.
     *
     * @param parent  the parent
     * @return        this instance
     */
    T setParent(P parent);

    /**
     * Returns the parent model if one exists, otherwise an empty
     * {@code Optional}.
     *
     * @return  the parent node if one exists
     */
    Optional getParent();

}