net.morimekta.config.ConfigBuilder 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!
/*
 * 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;

import net.morimekta.util.Stringable;

import java.util.Collection;
import java.util.Date;

/**
 * Base configuration container. Essentially a type-safe map that group
 * values into a few basic types:
 *
 * @deprecated Configs maps are deprecated in favor of true type-safe config
 *             provided by 'net.morimekta.providence:providence-config'. The
 *             'config-utils' module will be removed at end of 2.x version of
 *             utils.
 */
@Deprecated
public interface ConfigBuilder> extends Config {
    /**
     * Put a value into the config.
     *
     * @param key The config to put.
     * @param value The value to put.
     * @return The value replaced if the key was already present.
     */
    Object put(String key, Object value);

    /**
     * Put a value into the config.
     *
     * @param key The config to put.
     * @param value The value to put.
     * @return The value replaced if the key was already present.
     */
    default Object put(Stringable key, Object value) {
        return put(key.asString(), value);
    }

    /**
     * Remove entry key from the config.
     *
     * @param key The key to remove.
     * @return The value removed if any.
     */
    Object remove(String key);

    /**
     * Remove entry key from the config.
     *
     * @param key The key to remove.
     * @return The value removed if any.
     */
    default Object remove(Stringable key) {
        return remove(key.asString());
    }

    /**
     * Put all values from the 'other' config into this.
     *
     * @param other The other config.
     * @return The config.
     */
    @SuppressWarnings("unchecked")
    default Builder putAll(Config other) {
        for (String key : other.keySet()) {
            put(key, other.get(key));
        }
        return (Builder) this;
    }

    /**
     * Put a boolean value into the config.
     *
     * @param key The key to put at.
     * @param value The value to put.
     * @return The config.
     */
    @SuppressWarnings("unchecked")
    default Builder putBoolean(String key, boolean value) {
        put(key, value);
        return (Builder) this;
    }

    /**
     * Put a boolean value into the config.
     *
     * @param key The key to put at.
     * @param value The value to put.
     * @return The config.
     */
    @SuppressWarnings("unchecked")
    default Builder putBoolean(Stringable key, boolean value) {
        return putBoolean(key.asString(), value);
    }

    /**
     * Put an integer value into the config.
     *
     * @param key The key to put at.
     * @param value The value to put.
     * @return The config.
     */
    @SuppressWarnings("unchecked")
    default Builder putInteger(String key, int value) {
        put(key, value);
        return (Builder) this;
    }

    /**
     * Put an integer value into the config.
     *
     * @param key The key to put at.
     * @param value The value to put.
     * @return The config.
     */
    default Builder putInteger(Stringable key, int value) {
        return putInteger(key.asString(), value);
    }

    /**
     * Put a long value into the config.
     *
     * @param key The key to put at.
     * @param value The value to put.
     * @return The config.
     */
    @SuppressWarnings("unchecked")
    default Builder putLong(String key, long value) {
        put(key, value);
        return (Builder) this;
    }

    /**
     * Put a long value into the config.
     *
     * @param key The key to put at.
     * @param value The value to put.
     * @return The config.
     */
    default Builder putLong(Stringable key, long value) {
        return putLong(key.asString(), value);
    }

    /**
     * Put a double value into the config.
     *
     * @param key The key to put at.
     * @param value The value to put.
     * @return The config.
     */
    @SuppressWarnings("unchecked")
    default Builder putDouble(String key, double value) {
        put(key, value);
        return (Builder) this;
    }

    /**
     * Put a double value into the config.
     *
     * @param key The key to put at.
     * @param value The value to put.
     * @return The config.
     */
    default Builder putDouble(Stringable key, double value) {
        return putDouble(key.asString(), value);
    }

    /**
     * Put a string value into the config.
     *
     * @param key The key to put at.
     * @param value The value to put.
     * @return The config.
     */
    @SuppressWarnings("unchecked")
    default Builder putString(String key, String value) {
        put(key, value);
        return (Builder) this;
    }

    /**
     * Put a string value into the config.
     *
     * @param key The key to put at.
     * @param value The value to put.
     * @return The config.
     */
    default Builder putString(Stringable key, String value) {
        return putString(key.asString(), value);
    }

    /**
     * Put a date value into the config.
     *
     * @param key The key to put at.
     * @param value The value to put.
     * @return The config.
     */
    @SuppressWarnings("unchecked")
    default Builder putDate(String key, Date value) {
        put(key, value);
        return (Builder) this;
    }

    /**
     * Put a date value into the config.
     *
     * @param key The key to put at.
     * @param value The value to put.
     * @return The config.
     */
    @SuppressWarnings("unchecked")
    default Builder putDate(Stringable key, Date value) {
        return putDate(key.asString(), value);
    }

    /**
     * Put a collection value into the config.
     *
     * @param key The key to put at.
     * @param value The value to put.
     * @param  The collection item type.
     * @return The config.
     */
    @SuppressWarnings("unchecked")
    default  Builder putCollection(String key, Collection value) {
        put(key, value);
        return (Builder) this;
    }

    /**
     * Put a collection value into the config.
     *
     * @param key The key to put at.
     * @param value The value to put.
     * @param  The collection item type.
     * @return The config.
     */
    default  Builder putCollection(Stringable key, Collection value) {
        return putCollection(key.asString(), value);
    }
}