com.yelstream.topp.standard.microprofile.config.source.FixedMapConfigSource Maven / Gradle / Ivy

Go to download
/*
 * Project: Topp Standard
 * GitHub: https://github.com/sabroe/Topp-Standard
 *
 * Copyright 2024 Morten Sabroe Mortensen
 *
 * 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.yelstream.topp.standard.microprofile.config.source;

import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Singular;
import org.eclipse.microprofile.config.spi.ConfigSource;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

/**
 * Fixed-content, in-memory configuration-source keeping properties as a {@link Map}.
 * 
 *     All values are set and locked in the most conservative manner possible.
 * 
 * 
 *     This supports properties whose value is {@code null}.
 * 
 * 
 *     This is immutable.
 * 
 * 
 *     This is thread safe.
 * 
 *
 * @author Morten Sabroe Mortensen
 * @version 1.0
 * @since 2024-04-20
 */
@AllArgsConstructor(access=AccessLevel.PRIVATE)
public class FixedMapConfigSource implements ConfigSource {
    /**
     * Name.
     */
    private final String name;

    /**
     * Ordinal.
     */
    private final int ordinal;

    /**
     * Properties held.
     * This is immutable.
     * 
     *     Note that this, being based upon {@link HashMap}, does carry {@code null} values.
     * 
     */
    private final Map properties;

    @Override
    public String getName() {
        return name;
    }

    @Override
    public int getOrdinal() {
        return ordinal;
    }

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

    @Override
    public String getValue(String propertyName) {
        return properties.get(propertyName);
    }

    @Override
    public Map getProperties() {
        return properties;
    }

    public static FixedMapConfigSource of(String name,
                                         int ordinal,
                                         Map properties) {
        properties=properties==null?Map.of():properties;
        properties=Collections.unmodifiableMap(properties);
        return new FixedMapConfigSource(name,ordinal,properties);
    }

    @SuppressWarnings("unused")
    @lombok.Builder(builderClassName="Builder",toBuilder=true)
    private static FixedMapConfigSource createInstance(String name,
                                                       int ordinal,
                                                       @Singular Map properties) {
        return of(name,ordinal,Collections.unmodifiableMap(properties));
    }

    @SuppressWarnings({"java:S1068","java:S1450","unused","FieldCanBeLocal","UnusedReturnValue","FieldMayBeFinal"})
    public static class Builder {
        private String name=ConfigSources.createName();

        private int ordinal=ConfigSources.DEFAULT_ORDINAL;

        private Map properties=new HashMap<>();
    }
}