org.checkerframework.javacutil.DeepCopyable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of checker Show documentation

The Checker Framework enhances Java's type system to make it more powerful and useful. This lets software developers detect and prevent errors in their Java programs. The Checker Framework includes compiler plug-ins ("checkers") that find bugs or verify their absence. It also permits you to write your own compiler plug-ins.

There is a newer version: 3.42.0-eisop4

Show newest version

package org.checkerframework.javacutil;

import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.checker.nullness.qual.PolyNull;

/**
 * An interface for types that implement the {@link #deepCopy} method.
 *
 * @param  the type of the subtype of DeepCopyable
 * @deprecated use org.plumelib.util.DeepCopyable
 */
@Deprecated // 2023-06-02
public interface DeepCopyable {

    /**
     * Returns a deep copy of this. A deep copy is equal to the original, but side effects to either
     * object are not visible in the other. A deep copy may share immutable state with the original.
     *
     * The run-time class of the result is identical to the run-time class of this. The deep copy
     * is equal to {@code this} (per {@code equals()} if the object's class does not use reference
     * equality as {@code Object.equals()} does).
     *
     * @return a deep copy of this
     */
    T deepCopy();

    /**
     * Returns the deep copy of a non-null argument, or {@code null} for a {@code null} argument.
     *
     * @param object object to copy
     * @return the deep copy of a non-null argument, or {@code null} for a {@code null} argument
     * @param  the type of the object
     */
    static > @PolyNull T2 deepCopyOrNull(
            @PolyNull T2 object) {
        if (object == null) {
            return null;
        }
        return object.deepCopy();
    }
}