com.alee.api.merge.RecursiveMerge Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-core Show documentation
WebLaF core components
The newest version!
/*
 * This file is part of WebLookAndFeel library.
 *
 * WebLookAndFeel library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * WebLookAndFeel library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with WebLookAndFeel library.  If not, see .
 */

package com.alee.api.merge;

import com.alee.api.annotations.NotNull;
import com.alee.api.annotations.Nullable;

import java.io.Serializable;

/**
 * Recursive merge providing some extra options for {@link GlobalMergeBehavior}s.
 *
 * @author Mikle Garin
 * @see How to use Merge
 * @see Merge
 */
public interface RecursiveMerge extends Serializable
{
    /**
     * Performs merge result of the two provided objects and returns resulting object.
     *
     * @param type   expected resulting object {@link Class} type
     * @param base   base object
     * @param merged object to merge
     * @param depth  merge calls stack depth
     * @param     resulting object type
     * @return merge result of the two provided objects and returns resulting object
     */
    @Nullable
    public  T merge ( @NotNull Class type, @Nullable Object base, @Nullable Object merged, int depth );

    /**
     * Performs merge result of the two provided objects with all field values merged according to {@link Merge} settings.
     *
     * @param type   expected resulting object {@link Class} type
     * @param base   base object
     * @param merged object to merge
     * @param depth  merge calls stack depth
     * @param     resulting object type
     * @return merge result of the two provided objects with all field values merged according to {@link Merge} settings
     */
    @NotNull
    public  T mergeFields ( @NotNull Class type, @NotNull Object base, @NotNull Object merged, int depth );

    /**
     * Returns overwrite operation resulting object.
     * This is an utility method mostly for {@link GlobalMergeBehavior} implementations.
     *
     * @param base   object to overwrite
     * @param merged overwriting object
     * @return overwrite operation resulting object
     */
    @Nullable
    public Object overwrite ( @Nullable Object base, @Nullable Object merged );
}