io.github.sugarcubes.cloner.FieldCopier Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2023 the original author or authors.
 *
 * 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 io.github.sugarcubes.cloner;

/**
 * Field copier interface.
 *
 * @author Maxim Butov
 */
public interface FieldCopier {

    /**
     * No-op field copier.
     */
    FieldCopier NOOP = (original, clone, context) -> {
    };

    /**
     * Copies the field value from the original object to the clone.
     *
     * @param original original object
     * @param clone clone
     * @param context copying context
     * @throws Exception if something went wrong
     */
    void copy(Object original, Object clone, CopyContext context) throws Exception;

}