org.eclipse.jnosql.communication.keyvalue.KeyValueConfiguration Maven / Gradle / Ivy

Go to download
/*
 *  Copyright (c) 2023 Contributors to the Eclipse Foundation
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  and Apache License v2.0 which accompanies this distribution.
 *  The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 *  and the Apache License v2.0 is available at http://www.opensource.org/licenses/apache2.0.php.
 *  You may elect to redistribute this code under either of these licenses.
 *  Contributors:
 *  Otavio Santana
 */
package org.eclipse.jnosql.communication.keyvalue;


import org.eclipse.jnosql.communication.CommunicationException;
import org.eclipse.jnosql.communication.Settings;

import java.util.Objects;
import java.util.ServiceLoader;
import java.util.function.Function;

/**
 * It is a function that reads from {@link Settings} and then creates a manager factory instance.
 * It should return a {@link NullPointerException} when the {@link Settings} parameter is null.
 *
 * @see BucketManagerFactory
 * @see BucketManager
 */
public interface KeyValueConfiguration extends Function {

    /**
     * creates and returns a  {@link KeyValueConfiguration}  instance from {@link ServiceLoader}
     *
     * @param  the configuration type
     * @return {@link KeyValueConfiguration} instance
     */
    static  T getConfiguration() {
       return (T) ServiceLoader.load(KeyValueConfiguration.class)
                .stream()
                .map(ServiceLoader.Provider::get)
               .findFirst().orElseThrow(() -> new CommunicationException("No KeyValueConfiguration implementation found!"));
    }

    /**
     * creates and returns a  {@link KeyValueConfiguration} instance from {@link ServiceLoader}
     * for a particular provider implementation.
     *
     * @param       the configuration type
     * @param type the particular provider
     * @return {@link KeyValueConfiguration} instance
     */
    static  T getConfiguration(Class type) {
        Objects.requireNonNull(type, "service is required");
        return (T) ServiceLoader.load(KeyValueConfiguration.class)
                .stream()
                .map(ServiceLoader.Provider::get)
                .filter(type::isInstance)
                .findFirst().orElseThrow(() -> new CommunicationException("No KeyValueConfiguration implementation found!"));
    }
}