net.morimekta.config.impl.SimpleLayeredConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of config-util Show documentation

Configuration Utilities. NOTE: This module is deprecated and will be removed at the end of the v2.x versions of the utilities. Preferred config system after that is either to use true type-safe config with `net.morimekta.providence:providence-config` or to use a simple JSON or YAML library or java properties files. The semi-typesafe layered config did not really solve the problems I had hoped it would, and in essence this was just a helper for merging maps and getting pre-cast values out of it.

The newest version!

/*
 * Copyright (c) 2016, Stein Eldar Johnsen
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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 net.morimekta.config.impl;

import net.morimekta.config.Config;
import net.morimekta.config.LayeredConfig;
import net.morimekta.config.util.ConfigUtil;

import com.google.common.collect.ImmutableList;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;
import java.util.function.Supplier;

import static net.morimekta.config.util.ConfigUtil.getLayerName;

/**
 * The LayeredConfig is a non-thread-safe layered config, regarding editing.
 * Meaning each sub-config that is both modified and edited at the same time
 * needs it's own thread safety.
 * 
 *     NOTE:
 *         There is a race condition that may happen if values are removed
 *         from the supplied config that may result in values that still exist
 *         in a lower layer for a given key to return null from
 *         {@link #get(String)}.
 */
public class SimpleLayeredConfig implements Config, LayeredConfig {
    private final ArrayList> layers;

    private int top;
    private int bottom;

    /**
     * Create a layered config with a predefined set of configs. The configs
     * supported are added as in-memory fixed configs in the two middle groups
     * (top and bottom).
     *
     * @param configs The configs.
     */
    public SimpleLayeredConfig(Config... configs) {
        this.layers = new ArrayList<>();
        for (Config config : configs) {
            this.layers.add(() -> config);
        }
        this.top = 0;
        this.bottom = layers.size();
    }

    /**
     * Create a layered config with the given suppliers as the initial middle
     * two groups of layers.
     *
     * @param suppliers The config suppliers.
     */
    public SimpleLayeredConfig(Collection> suppliers) {
        this.layers = new ArrayList<>();
        this.layers.addAll(suppliers);

        this.top = 0;
        this.bottom = layers.size();
    }

    @Override
    public LayeredConfig addFixedTopLayer(Supplier supplier) {
        layers.add(0, supplier);
        ++top;
        ++bottom;
        return this;
    }

    @Override
    public LayeredConfig addTopLayer(Supplier supplier) {
        layers.add(top, supplier);
        ++bottom;
        return this;
    }

    @Override
    public LayeredConfig addBottomLayer(Supplier supplier) {
        layers.add(bottom, supplier);
        ++bottom;
        return this;
    }

    @Override
    public LayeredConfig addFixedBottomLayer(Supplier supplier) {
        layers.add(supplier);
        return this;
    }

    @Override
    public String getLayerFor(String key) {
        for (Supplier supplier : layers) {
            Config config = supplier.get();
            if (config.containsKey(key)) {
                return getLayerName(supplier);
            }
        }

        return null;
    }

    @Override
    public Object get(String key) {
        for (Supplier supplier : layers) {
            Config config = supplier.get();
            // TODO(morimekta): There may be a race condition if values are
            // **removed** from the supplied config. If that is not happening
            // this should be entirely thread-safe.
            if (config.containsKey(key)) {
                return config.get(key);
            }
        }
        return null;
    }

    @Override
    public boolean containsKey(String key) {
        for (Supplier supplier : layers) {
            Config config = supplier.get();
            if (config.containsKey(key)) {
                return true;
            }
        }
        return false;
    }

    @Override
    public Set keySet() {
        TreeSet set = new TreeSet<>();
        for (Supplier supplier : layers) {
            Config config = supplier.get();
            set.addAll(config.keySet());
        }
        return set;
    }

    @Override
    public boolean equals(Object o) {
        if (o == this) {
            return true;
        } else if (o == null || !(o instanceof Config)) {
            return false;
        }
        return ConfigUtil.equals(this, (Config) o);
    }

    @Override
    public int hashCode() {
        return ConfigUtil.hashCode(this);
    }

    @Override
    public String toString() {
        return ConfigUtil.toString(this);
    }

    /**
     * In case sub-classes need access to the layers (in some order).
     *
     * @return The layer list, ordered from top to bottom.
     */
    protected List> layers() {
        return ImmutableList.copyOf(layers);
    }
}