com.alee.api.clone.GlobalCloneBehavior 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 java.io.Serializable;

/**
 * Global objects clone behavior.
 * It is asked to perform clone if it {@link #supports(RecursiveClone, Object)} provided objects.
 *
 * @param  cloned object type
 * @author Mikle Garin
 * @see How to use Clone
 * @see Clone
 */
public interface GlobalCloneBehavior extends Serializable
{
    /**
     * Returns whether or not this behavior supports cloning of the specified object.
     *
     * @param clone  {@link RecursiveClone} algorithm
     * @param object object to clone, should never be {@code null}
     * @return {@code true} if this behavior supports cloning of the specified specified object, {@code false} otherwise
     */
    public boolean supports ( @NotNull RecursiveClone clone, @NotNull Object object );

    /**
     * Returns clone of the specified object.
     *
     * @param clone  {@link RecursiveClone} algorithm
     * @param object object to clone, should never be {@code null}
     * @param depth  clone calls stack depth
     * @return clone of the specified object
     */
    @NotNull
    public O clone ( @NotNull RecursiveClone clone, @NotNull O object, int depth );

    /**
     * Return whether or not values cloned by this behavior are storable for recursive clone operation.
     *
     * @return {@code true} if values cloned by this behavior are storable for recursive clone operation, {@code false} otherwise
     */
    public boolean isStorable ();
}