com.alee.api.clone.RecursiveClone 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.clone;

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

import java.io.Serializable;

/**
 * Recursive clone providing some extra options for {@link GlobalCloneBehavior}s.
 *
 * @author Mikle Garin
 * @see How to use Clone
 * @see Clone
 */
public interface RecursiveClone extends Serializable
{
    /**
     * Stores reference to object clone.
     *
     * @param object object
     * @param clone  object clone
     */
    public void store ( @NotNull Object object, @Nullable Object clone );

    /**
     * Returns object clone if it is already available, {@code null} otherwise.
     *
     * @param object object to retrieve cached clone for
     * @return object clone if it is already available, {@code null} otherwise
     */
    @Nullable
    public Object retrieve ( @NotNull Object object );

    /**
     * Returns clone of the specified object.
     *
     * @param object object to clone
     * @param depth  clone calls stack depth
     * @param     cloned object type
     * @return clone of the specified object
     */
    @Nullable
    public  T clone ( @Nullable T object, int depth );

    /**
     * Returns clone of the specified object with all field values cloned according to {@link Clone} settings.
     *
     * @param object object to clone
     * @param depth  clone calls stack depth
     * @param     cloned object type
     * @return clone of the specified object with all field values cloned according to {@link Clone} settings
     */
    @NotNull
    public  T cloneFields ( @NotNull T object, int depth );
}