Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
io.rxmicro.config.AsMapConfig Maven / Gradle / Ivy
/*
* Copyright (c) 2020. https://rxmicro.io
*
* 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.rxmicro.config;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import static io.rxmicro.common.util.ExCollections.unmodifiableOrderedMap;
/**
* The parent class for all config classes that use {@link Map} as value storage.
*
* @author nedis
* @since 0.7
*/
@SuppressWarnings("NullableProblems")
public class AsMapConfig extends Config implements Map {
private Map map;
/**
* This is basic class designed for extension only.
*/
protected AsMapConfig() {
// This is basic class designed for extension only.
}
/**
* Returns {@code true} if the current config should support {@link Map}{@code } values.
*
*
* Child class can override this method to enable/disable map supporting.
*
* @return {@code true} if the current config should support {@link Map}{@code } values.
* @see #getMap(String)
*/
public boolean supportsMap() {
return true;
}
/**
* Returns {@code true} if the current config should support {@link List}{@code } values.
*
*
* Child class can override this method to enable/disable list supporting.
*
* @return {@code true} if the current config should support {@link List}{@code } values.
* @see #getList(String)
*/
public boolean supportsList() {
return true;
}
/**
* Sets the map instance.
*
* @param map the map instance
*/
public void setMap(final Map map) {
this.map = unmodifiableOrderedMap(map);
}
@Override
public int size() {
return map.size();
}
@Override
public boolean isEmpty() {
return map.isEmpty();
}
@Override
public boolean containsKey(final Object key) {
return map.containsKey(key);
}
@Override
public boolean containsValue(final Object value) {
return map.containsValue(value);
}
@Override
public Object get(final Object key) {
return map.get(key);
}
@Override
public Object put(final String key,
final Object value) {
return map.put(key, value);
}
@Override
public Object remove(final Object key) {
return map.remove(key);
}
@Override
public void putAll(final Map sourceMap) {
map.putAll(sourceMap);
}
@Override
public void clear() {
map.clear();
}
@Override
public Set keySet() {
return map.keySet();
}
@Override
public Collection values() {
return map.values();
}
@Override
public Set> entrySet() {
return map.entrySet();
}
/**
* Returns {@code true} if values to which the specified key is mapped has {@link String} type.
*
*
* Note: If value not found by key, this method returns {@code false}.
*
* @param key the key whose associated value is to be checked.
* @return {@code true} if values to which the specified key is mapped has {@link String} type.
*/
public boolean isString(final String key) {
return map.get(key) instanceof String;
}
/**
* Returns the {@link String} value to which the specified key is mapped.
*
* @param key the key whose associated value is to be returned
* @return the {@link String} value to which the specified key is mapped
* @throws ClassCastException if the value is of an inappropriate type for this map.
* @throws ConfigException if the value is not found by the provided key.
*/
public String getString(final String key) {
return (String) getRequired(key);
}
/**
* Returns the {@link String} value to which the specified key is mapped,
* or {@code null} if this map contains no mapping for the key.
*
* @param key the key whose associated value is to be returned
* @return the {@link String} value to which the specified key is mapped, or
* {@code null} if this map contains no mapping for the key
* @throws ClassCastException if the value is of an inappropriate type for this map.
*/
public Optional getOptionalString(final String key) {
return Optional.ofNullable((String) get(key));
}
/**
* Returns {@code true} if values to which the specified key is mapped has {@link Boolean} type.
*
*
* Note: If value not found by key, this method returns {@code false}.
*
* @param key the key whose associated value is to be checked.
* @return {@code true} if values to which the specified key is mapped has {@link Boolean} type.
*/
public boolean isBoolean(final String key) {
return map.get(key) instanceof Boolean;
}
/**
* Returns the {@link Boolean} value to which the specified key is mapped.
*
* @param key the key whose associated value is to be returned
* @return the {@link Boolean} value to which the specified key is mapped.
* @throws ClassCastException if the value is of an inappropriate type for this map.
* @throws ConfigException if the value is not found by the provided key.
*/
public boolean getBoolean(final String key) {
return (Boolean) getRequired(key);
}
/**
* Returns the {@link Boolean} value to which the specified key is mapped,
* or {@code null} if this map contains no mapping for the key.
*
* @param key the key whose associated value is to be returned
* @return the {@link Boolean} value to which the specified key is mapped, or
* {@code null} if this map contains no mapping for the key
* @throws ClassCastException if the value is of an inappropriate type for this map.
*/
public Optional getOptionalBoolean(final String key) {
return Optional.ofNullable((Boolean) get(key));
}
/**
* Returns {@code true} if values to which the specified key is mapped has {@link BigInteger} type.
*
*
* Note: If value not found by key, this method returns {@code false}.
*
* @param key the key whose associated value is to be checked.
* @return {@code true} if values to which the specified key is mapped has {@link BigInteger} type.
*/
public boolean isBigInteger(final String key) {
return map.get(key) instanceof BigInteger;
}
/**
* Returns the {@link BigInteger} value to which the specified key is mapped.
*
* @param key the key whose associated value is to be returned
* @return the {@link BigInteger} value to which the specified key is mapped.
* @throws ClassCastException if the value is of an inappropriate type for this map.
* @throws ConfigException if the value is not found by the provided key.
*/
public BigInteger getBigInteger(final String key) {
return (BigInteger) getRequired(key);
}
/**
* Returns the {@link BigInteger} value to which the specified key is mapped,
* or {@code null} if this map contains no mapping for the key.
*
* @param key the key whose associated value is to be returned
* @return the {@link BigInteger} value to which the specified key is mapped, or
* {@code null} if this map contains no mapping for the key
* @throws ClassCastException if the value is of an inappropriate type for this map.
*/
public Optional getOptionalBigInteger(final String key) {
return Optional.ofNullable((BigInteger) get(key));
}
/**
* Returns {@code true} if values to which the specified key is mapped has {@link Long} type.
*
*
* Note: If value not found by key, this method returns {@code false}.
*
* @param key the key whose associated value is to be checked.
* @return {@code true} if values to which the specified key is mapped has {@link Long} type.
*/
public boolean isLong(final String key) {
return map.get(key) instanceof Long;
}
/**
* Returns the {@link Long} value to which the specified key is mapped.
*
* @param key the key whose associated value is to be returned
* @return the {@link Long} value to which the specified key is mapped.
* @throws ClassCastException if the value is of an inappropriate type for this map.
* @throws ConfigException if the value is not found by the provided key.
*/
public Long getLong(final String key) {
return (Long) getRequired(key);
}
/**
* Returns the {@link Long} value to which the specified key is mapped,
* or {@code null} if this map contains no mapping for the key.
*
* @param key the key whose associated value is to be returned
* @return the {@link Long} value to which the specified key is mapped, or
* {@code null} if this map contains no mapping for the key
* @throws ClassCastException if the value is of an inappropriate type for this map.
*/
public Optional getOptionalLong(final String key) {
return Optional.ofNullable((Long) get(key));
}
/**
* Returns the {@link Integer} value to which the specified key is mapped.
*
* @param key the key whose associated value is to be returned
* @return the {@link Integer} value to which the specified key is mapped.
* @throws ClassCastException if the value is of an inappropriate type for this map.
* @throws ConfigException if the value is not found by the provided key.
*/
public Integer getInteger(final String key) {
return ((Number) getRequired(key)).intValue();
}
/**
* Returns the {@link Integer} value to which the specified key is mapped,
* or {@code null} if this map contains no mapping for the key.
*
* @param key the key whose associated value is to be returned
* @return the {@link Integer} value to which the specified key is mapped, or
* {@code null} if this map contains no mapping for the key
* @throws ClassCastException if the value is of an inappropriate type for this map.
*/
public Optional getOptionalInteger(final String key) {
return Optional.ofNullable((Number) get(key)).map(Number::intValue);
}
/**
* Returns the {@link Short} value to which the specified key is mapped.
*
* @param key the key whose associated value is to be returned
* @return the {@link Short} value to which the specified key is mapped.
* @throws ClassCastException if the value is of an inappropriate type for this map.
* @throws ConfigException if the value is not found by the provided key.
*/
public Short getShort(final String key) {
return ((Number) getRequired(key)).shortValue();
}
/**
* Returns the {@link Short} value to which the specified key is mapped,
* or {@code null} if this map contains no mapping for the key.
*
* @param key the key whose associated value is to be returned
* @return the {@link Short} value to which the specified key is mapped, or
* {@code null} if this map contains no mapping for the key
* @throws ClassCastException if the value is of an inappropriate type for this map.
*/
public Optional getOptionalShort(final String key) {
return Optional.ofNullable((Number) get(key)).map(Number::shortValue);
}
/**
* Returns {@code true} if values to which the specified key is mapped has {@link BigDecimal} type.
*
*
* Note: If value not found by key, this method returns {@code false}.
*
* @param key the key whose associated value is to be checked.
* @return {@code true} if values to which the specified key is mapped has {@link BigDecimal} type.
*/
public boolean isBigDecimal(final String key) {
return map.get(key) instanceof BigDecimal;
}
/**
* Returns the {@link BigDecimal} value to which the specified key is mapped.
*
* @param key the key whose associated value is to be returned
* @return the {@link BigDecimal} value to which the specified key is mapped.
* @throws ClassCastException if the value is of an inappropriate type for this map.
* @throws ConfigException if the value is not found by the provided key.
*/
public BigDecimal getBigDecimal(final String key) {
return (BigDecimal) getRequired(key);
}
/**
* Returns the {@link BigDecimal} value to which the specified key is mapped,
* or {@code null} if this map contains no mapping for the key.
*
* @param key the key whose associated value is to be returned
* @return the {@link BigDecimal} value to which the specified key is mapped, or
* {@code null} if this map contains no mapping for the key
* @throws ClassCastException if the value is of an inappropriate type for this map.
*/
public Optional getOptionalBigDecimal(final String key) {
return Optional.ofNullable((BigDecimal) get(key));
}
/**
* Returns the {@link Double} value to which the specified key is mapped.
*
* @param key the key whose associated value is to be returned
* @return the {@link Double} value to which the specified key is mapped.
* @throws ClassCastException if the value is of an inappropriate type for this map.
* @throws ConfigException if the value is not found by the provided key.
*/
public Double getDouble(final String key) {
return ((Number) getRequired(key)).doubleValue();
}
/**
* Returns the {@link Double} value to which the specified key is mapped,
* or {@code null} if this map contains no mapping for the key.
*
* @param key the key whose associated value is to be returned
* @return the {@link Double} value to which the specified key is mapped, or
* {@code null} if this map contains no mapping for the key
* @throws ClassCastException if the value is of an inappropriate type for this map.
*/
public Optional getOptionalDouble(final String key) {
return Optional.ofNullable((Number) get(key)).map(Number::doubleValue);
}
/**
* Returns the {@link Float} value to which the specified key is mapped.
*
* @param key the key whose associated value is to be returned
* @return the {@link Float} value to which the specified key is mapped.
* @throws ClassCastException if the value is of an inappropriate type for this map.
* @throws ConfigException if the value is not found by the provided key.
*/
public Float getFloat(final String key) {
return ((Number) getRequired(key)).floatValue();
}
/**
* Returns the {@link Float} value to which the specified key is mapped,
* or {@code null} if this map contains no mapping for the key.
*
* @param key the key whose associated value is to be returned
* @return the {@link Float} value to which the specified key is mapped, or
* {@code null} if this map contains no mapping for the key
* @throws ClassCastException if the value is of an inappropriate type for this map.
*/
public Optional getOptionalFloat(final String key) {
return Optional.ofNullable((Number) get(key)).map(Number::floatValue);
}
/**
* Returns {@code true} if values to which the specified key is mapped has {@link Map} type.
*
*
* Note: If value not found by key, this method returns {@code false}.
*
* @param key the key whose associated value is to be checked.
* @return {@code true} if values to which the specified key is mapped has {@link Map} type.
*/
public boolean isMap(final String key) {
return map.get(key) instanceof Map;
}
/**
* Returns the {@link Map}{@code } value to which the specified key is mapped.
*
* @param key the key whose associated value is to be returned
* @return the {@link Map}{@code } value to which the specified key is mapped.
* @throws ClassCastException if the value is of an inappropriate type for this map.
* @throws ConfigException if the value is not found by the provided key.
*/
@SuppressWarnings("unchecked")
public Map getMap(final String key) {
return (Map) getRequired(key);
}
/**
* Returns the {@link Map}{@code } value to which the specified key is mapped,
* or {@code null} if this map contains no mapping for the key.
*
* @param key the key whose associated value is to be returned
* @return the {@link Map}{@code } value to which the specified key is mapped, or
* {@code null} if this map contains no mapping for the key
* @throws ClassCastException if the value is of an inappropriate type for this map.
*/
@SuppressWarnings("unchecked")
public Optional> getOptionalMap(final String key) {
return Optional.ofNullable((Map) get(key));
}
/**
* Returns {@code true} if values to which the specified key is mapped has {@link List} type.
*
*
* Note: If value not found by key, this method returns {@code false}.
*
* @param key the key whose associated value is to be checked.
* @return {@code true} if values to which the specified key is mapped has {@link List} type.
*/
public boolean isList(final String key) {
return map.get(key) instanceof List;
}
/**
* Returns the {@link List}{@code } value to which the specified key is mapped.
*
* @param key the key whose associated value is to be returned
* @return the {@link List}{@code } value to which the specified key is mapped.
* @throws ClassCastException if the value is of an inappropriate type for this map.
* @throws ConfigException if the value is not found by the provided key.
*/
@SuppressWarnings("unchecked")
public List getList(final String key) {
return (List) getRequired(key);
}
/**
* Returns the {@link List}{@code } value to which the specified key is mapped,
* or {@code null} if this map contains no mapping for the key.
*
* @param key the key whose associated value is to be returned
* @return the {@link List}{@code } value to which the specified key is mapped, or
* {@code null} if this map contains no mapping for the key
* @throws ClassCastException if the value is of an inappropriate type for this map.
*/
@SuppressWarnings("unchecked")
public Optional> getOptionalList(final String key) {
return Optional.ofNullable((List) get(key));
}
private Object getRequired(final String key) {
final Object value = get(key);
if (value == null) {
throw new ConfigException("Required value for '?' not defined!", key);
}
return value;
}
@Override
public String toString() {
return getClass().getSimpleName() + "{" +
"map=" + map +
'}';
}
}
