org.sugarcubes.cloner.AbstractMappedPolicy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sugar-cubes-cloner Show documentation

Deep cloning of any objects

There is a newer version: 1.2.3

/*
 * 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 org.sugarcubes.cloner;

import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;

/**
 * Copy policy implementation based on {@link Map}.
 *
 * @param  input object type
 * @param  map key type
 *
 * @author Maxim Butov
 */
public abstract class AbstractMappedPolicy implements CopyPolicy {

    /**
     * Map (key, copy action).
     */
    private final Map map;

    /**
     * Creates policy.
     *
     * @param map map (key, action)
     */
    public AbstractMappedPolicy(Map map) {
        this(map, LinkedHashMap::new);
    }

    /**
     * Creates policy.
     *
     * @param map map (key, action)
     * @param mapCopyConstructor copy constructor of map as method reference
     */
    public AbstractMappedPolicy(Map map, Function, Map> mapCopyConstructor) {
        Map copy = mapCopyConstructor.apply(map);
        copy.entrySet().removeIf(e -> e.getValue() == CopyAction.DEFAULT);
        this.map = copy.isEmpty() ? Collections.emptyMap() : copy;
    }

    /**
     * Returns copy action by key or default if not found.
     *
     * @param key key
     * @return copy action
     */
    protected CopyAction get(K key) {
        return map.getOrDefault(key, CopyAction.DEFAULT);
    }

    /**
     * Returns map's entry set.
     *
     * @return map's entry set
     */
    protected Set> entrySet() {
        return map.entrySet();
    }

}