net.morimekta.config.Config 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
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.
/*
* 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.config.util.ConfigUtil;
import net.morimekta.config.util.ValueConverter;
import net.morimekta.util.Stringable;
import java.util.Collection;
import java.util.Date;
import java.util.Set;
import static net.morimekta.config.util.ConfigUtil.asBoolean;
import static net.morimekta.config.util.ConfigUtil.asCollection;
import static net.morimekta.config.util.ConfigUtil.asDate;
import static net.morimekta.config.util.ConfigUtil.asDouble;
import static net.morimekta.config.util.ConfigUtil.asInteger;
import static net.morimekta.config.util.ConfigUtil.asLong;
import static net.morimekta.config.util.ConfigUtil.asString;
/**
* Base configuration container. Essentially a type-safe map.
*
* It is not implementing the Map base class since it would require also
* implementing generic entry adders (put, putAll), and getType unsafe getters.
*
* @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 Config {
/**
* Look up a single value from the config.
*
* @param key The key to look for.
* @return The value if found, null otherwise.
*/
Object get(String key);
/**
* Look up a single value from the config.
*
* @param key The key to look for.
* @return The value if found, null otherwise.
*/
default Object get(Stringable key) {
return get(key.asString());
}
/**
* Checks if the key exists in the config.
*
* @param key The key to look for.
* @return True if the value exists. False otherwise.
*/
boolean containsKey(String key);
/**
* Checks if the key exists in the config.
*
* @param key The key to look for.
* @return True if the value exists. False otherwise.
*/
default boolean containsKey(Stringable key) {
return containsKey(key.asString());
}
/**
* Get the set of keys available in the config.
*
* @return The key set.
*/
Set keySet();
/**
* @param key The key to look for.
* @return The string value.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default String getString(String key) {
return asString(getValue(key));
}
/**
* @param key The key to look for.
* @return The string value.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default String getString(Stringable key) {
return getString(key.asString());
}
/**
* @param key The key to look for.
* @param def The default value if not found.
* @return The string value.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default String getString(String key, String def) {
return getWithDefault(key, ConfigUtil::asString, def);
}
/**
* @param key The key to look for.
* @param def The default value if not found.
* @return The string value.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default String getString(Stringable key, String def) {
return getString(key.asString(), def);
}
/**
* @param key The key to look for.
* @return The boolean value.
* @throws KeyNotFoundException When the key does not exist.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default boolean getBoolean(String key) {
return asBoolean(getValue(key));
}
/**
* @param key The key to look for.
* @return The boolean value.
* @throws KeyNotFoundException When the key does not exist.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default boolean getBoolean(Stringable key) {
return getBoolean(key.asString());
}
/**
* @param key The key to look for.
* @param def The default value if not found.
* @return The boolean value.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default boolean getBoolean(String key, boolean def) {
return getWithDefault(key, ConfigUtil::asBoolean, def);
}
/**
* @param key The key to look for.
* @param def The default value if not found.
* @return The boolean value.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default boolean getBoolean(Stringable key, boolean def) {
return getBoolean(key.asString(), def);
}
/**
* @param key The key to look for.
* @return The integer value.
* @throws KeyNotFoundException When the key does not exist.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default int getInteger(String key) {
return asInteger(getValue(key));
}
/**
* @param key The key to look for.
* @return The integer value.
* @throws KeyNotFoundException When the key does not exist.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default int getInteger(Stringable key) {
return getInteger(key.asString());
}
/**
* @param key The key to look for.
* @param def The default value if not found.
* @return The integer value.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default int getInteger(String key, int def) {
return getWithDefault(key, ConfigUtil::asInteger, def);
}
/**
* @param key The key to look for.
* @param def The default value if not found.
* @return The integer value.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default int getInteger(Stringable key, int def) {
return getInteger(key.asString(), def);
}
/**
* @param key The key to look for.
* @return The long value.
* @throws KeyNotFoundException When the key does not exist.
* @throws IncompatibleValueException When a value cannot be converted to
* requested getType.
*/
default long getLong(String key) {
return asLong(getValue(key));
}
/**
* @param key The key to look for.
* @return The long value.
* @throws KeyNotFoundException When the key does not exist.
* @throws IncompatibleValueException When a value cannot be converted to
* requested getType.
*/
default long getLong(Stringable key) {
return getLong(key.asString());
}
/**
* @param key The key to look for.
* @param def The default value if not found.
* @return The long value.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default long getLong(String key, long def) {
return getWithDefault(key, ConfigUtil::asLong, def);
}
/**
* @param key The key to look for.
* @param def The default value if not found.
* @return The long value.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default long getLong(Stringable key, long def) {
return getLong(key.asString(), def);
}
/**
* @param key The key to look for.
* @return The double value.
* @throws KeyNotFoundException When the key does not exist.
* @throws IncompatibleValueException When a value cannot be converted to
* requested getType.
*/
default double getDouble(String key) {
return asDouble(getValue(key));
}
/**
* @param key The key to look for.
* @return The double value.
* @throws KeyNotFoundException When the key does not exist.
* @throws IncompatibleValueException When a value cannot be converted to
* requested getType.
*/
default double getDouble(Stringable key) {
return getDouble(key.asString());
}
/**
* @param key The key to look for.
* @param def The default value if not found.
* @return The double value.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default double getDouble(String key, double def) {
return getWithDefault(key, ConfigUtil::asDouble, def);
}
/**
* @param key The key to look for.
* @param def The default value if not found.
* @return The double value.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default double getDouble(Stringable key, double def) {
return getDouble(key.asString(), def);
}
/**
* @param key The key to look for.
* @return The date value.
* @throws KeyNotFoundException When the key does not exist.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default Date getDate(String key) {
return asDate(getValue(key));
}
/**
* @param key The key to look for.
* @return The date value.
* @throws KeyNotFoundException When the key does not exist.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default Date getDate(Stringable key) {
return getDate(key.asString());
}
/**
* @param key The key to look for.
* @param def The default value if not found.
* @return The date value.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default Date getDate(String key, Date def) {
return getWithDefault(key, ConfigUtil::asDate, def);
}
/**
* @param key The key to look for.
* @param def The default value if not found.
* @return The date value.
* @throws IncompatibleValueException When a value cannot be converted to
* requested type.
*/
default Date getDate(Stringable key, Date def) {
return getDate(key.asString(), def);
}
/**
* @param key The key to look for.
* @param The collection entry type.
* @return The collection.
*/
default Collection getCollection(String key) {
return asCollection(getValue(key));
}
/**
* @param key The key to look for.
* @param The collection entry type.
* @return The collection.
*/
default Collection getCollection(Stringable key) {
return getCollection(key.asString());
}
/**
* Get a value from the config looking up deeply into the config. It can also look
* "up" from the object. The "up" context is always the same for the same config
* instance. E.g.
*
* @param key The key to look up.
* @param The value type.
* @return The value.
* @throws KeyNotFoundException If not found.
*/
@SuppressWarnings("unchecked")
default T getValue(String key) {
if (!containsKey(key)) {
throw new KeyNotFoundException("No such config entry \"" + key + "\"");
}
return (T) get(key);
}
/**
* Look up a single value from the config. If not found return a default
* value. Convert the value using the given converter function.
*
* @param key The key to look for.
* @param convert Value converter function.
* @param def The default value.
* @param The value type.
* @return The value if found, otherwise the default.
*/
default T getWithDefault(String key, ValueConverter convert, T def) {
if (containsKey(key)) {
return convert.convert(get(key));
}
return def;
}
}