io.github.sugarcubes.cloner.CopyAction 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;

/**
 * Actions which can be applied to objects/types/fields.
 *
 * @author Maxim Butov
 */
public enum CopyAction {

    /**
     * Skip field.
     * This action is applicable to fields only.
     */
    SKIP,

    /**
     * Use {@code null} instead of original object.
     * This action is not applicable to primitive fields.
     */
    NULL,

    /**
     * Use the original object.
     */
    ORIGINAL,

    /**
     * Clone the object, if it is not immutable.
     */
    DEFAULT,

}