com.landawn.abacus.util.Properties Maven / Gradle / Ivy

/*
 * Copyright (C) 2015 HaiYang Li
 *
 * 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 com.landawn.abacus.util;

import java.util.Collection;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;

/**
 * 
 * @since 0.8
 * 
 * @author Haiyang Li
 */
public class Properties implements Map {
    protected final Map values;

    public Properties() {
        this(new ConcurrentHashMap());
    }

    /**
     * 
     * @param valueMap The valueMap and this Properties share the same data; any changes to one will appear in the other.
     */
    Properties(final ConcurrentHashMap valueMap) {
        this.values = (Map) valueMap;
    }

    public static  Properties from(final Map map) {
        return new Properties(new ConcurrentHashMap(map));
    }

    @Override
    public V get(Object propName) {
        return values.get(propName);
    }

    /**
     * To avoid NullPointerException for primitive type if the target property is null or not set.
     * 
     * @param targetClass
     * @param propName
     * @return
     */
    @SuppressWarnings("unchecked")
    public  T get(Class targetClass, Object propName) {
        return N.convert(values.get(propName), targetClass);
    }

    /**
     * 
     * @param propName
     * @param defaultValue
     *            is returned if the specified {@code propName} is not contained in this Properties instance or it's
     *            null.
     * @return
     */
    @SuppressWarnings("unchecked")
    public V getOrDefault(Object propName, V defaultValue) {
        V result = values.get(propName);

        if (result == null) {
            return defaultValue;
        }

        return result;
    }

    /**
     * 
     * @param targetClass
     * @param propName
     * @param defaultValue
     *            is returned if the specified {@code propName} is not contained in this Properties instance or it's null.
     * @return
     */
    public  T getOrDefault(Class targetClass, Object propName, T defaultValue) {
        Object result = values.get(propName);

        if (result == null) {
            return defaultValue;
        }

        return N.convert(result, targetClass);
    }

    /**
     * 
     * @param propName
     * @param propValue
     * @return the same property
     */
    public Properties set(K propName, V propValue) {
        put(propName, propValue);

        return this;
    }

    @Override
    public V put(K key, V value) {
        return values.put(key, value);
    }

    @Override
    public void putAll(Map m) {
        values.putAll(m);
    }

    public V putIfAbsent(K key, V value) {
        V v = get(key);

        if (v == null) {
            v = put(key, value);
        }

        return v;
    }

    @Override
    public V remove(Object key) {
        return values.remove(key);
    }

    /**
     * Removes the entry for the specified key only if it is currently
     * mapped to the specified value.
     */
    public boolean remove(Object key, Object value) {
        final Object curValue = get(key);

        if (!Objects.equals(curValue, value) || (curValue == null && !containsKey(key))) {
            return false;
        }

        remove(key);

        return true;
    }

    /**
     * Replaces the entry for the specified key only if it is
     * currently mapped to some value.
     */
    public V replace(K key, V value) {
        V curValue;
        if (((curValue = get(key)) != null) || containsKey(key)) {
            curValue = put(key, value);
        }
        return curValue;
    }

    /**
     * Replaces the entry for the specified key only if currently
     * mapped to the specified value.
     */
    public boolean replace(K key, V oldValue, V newValue) {
        Object curValue = get(key);
        if (!Objects.equals(curValue, oldValue) || (curValue == null && !containsKey(key))) {
            return false;
        }
        put(key, newValue);
        return true;
    }

    @Override
    public boolean containsKey(Object key) {
        return values.containsKey(key);
    }

    @Override
    public boolean containsValue(Object value) {
        return values.containsValue(value);
    }

    @Override
    public Set keySet() {
        return values.keySet();
    }

    @Override
    public Collection values() {
        return values.values();
    }

    @Override
    public Set> entrySet() {
        return values.entrySet();
    }

    @Override
    public boolean isEmpty() {
        return values.isEmpty();
    }

    @Override
    public int size() {
        return values.size();
    }

    @Override
    public void clear() {
        values.clear();
    }

    public Properties copy() {
        final Properties copy = new Properties();

        copy.values.putAll(this.values);

        return copy;
    }

    @Override
    public int hashCode() {
        return 31 + ((values == null) ? 0 : values.hashCode());
    }

    @Override
    public boolean equals(Object obj) {
        return this == obj || (obj instanceof Properties && N.equals(((Properties) obj).values, values));
    }

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