com.swirlds.config.api.intern.ConfigurationProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swirlds-config-api Show documentation

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

There is a newer version: 0.56.3

Show newest version

/*
 * Copyright (C) 2022-2023 Hedera Hashgraph, LLC
 *
 * 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.swirlds.config.api.intern;

import com.swirlds.config.api.ConfigurationBuilder;
import com.swirlds.config.api.spi.ConfigurationBuilderFactory;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.Iterator;
import java.util.ServiceLoader;

/**
 * This class is the only private API of the config API that is used to load an implementation of the config API by
 * using the Java SPI (see {@link ServiceLoader}).
 */
public final class ConfigurationProvider {

    private static final ConfigurationProvider INSTANCE = new ConfigurationProvider();

    private final ConfigurationBuilderFactory factory;

    private ConfigurationProvider() {
        factory = loadImplementation(ConfigurationProvider.class.getClassLoader());
    }

    @NonNull
    private static ConfigurationBuilderFactory loadImplementation(@NonNull final ClassLoader classloader) {
        final ServiceLoader serviceLoader =
                ServiceLoader.load(ConfigurationBuilderFactory.class, classloader);
        final Iterator iterator = serviceLoader.iterator();
        if (iterator.hasNext()) {
            return iterator.next();
        }
        throw new IllegalStateException("No ConfigurationBuilderFactory implementation found!");
    }

    /**
     * This method is the facade against an implementation of the config API. The method returns a new {@link
     * ConfigurationBuilder} instance that is created by a concrete implementation.
     *
     * @return a new {@link ConfigurationBuilder} instance
     */
    public ConfigurationBuilder createBuilder() {
        return factory.create();
    }

    /**
     * Access to this class that is defined by a singleton
     *
     * @return the singleton instance of this class
     */
    public static ConfigurationProvider getInstance() {
        return INSTANCE;
    }
}