jakarta.nosql.document.DocumentConfigurationAsync Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of communication-document Show documentation
There is a newer version: 1.0.0-b5
Show newest version
/*
 * Copyright (c) 2019 Otavio Santana and others
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the Eclipse
 * Public License v. 2.0 are satisfied: GNU General Public License, version 2
 * with the GNU Classpath Exception which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */
package jakarta.nosql.document;

import jakarta.nosql.ServiceLoaderProvider;
import jakarta.nosql.Settings;

/**
 * The Jakarta NoSQL communication configuration to create a {@link DocumentCollectionManagerFactory}
 *
 */
public interface DocumentConfigurationAsync {

    /**
     * Reads configuration either from default configuration or a file defined by NoSQL provider and then creates a
     * {@link DocumentCollectionManagerAsyncFactory} instance.
     *
     * @param  the type {@link DocumentCollectionManagerAsyncFactory}
     * @return a {@link DocumentCollectionManagerAsyncFactory} instance
     */
     T get();

    /**
     * Reads configuration from the {@link Settings} instance, the parameters are defined by NoSQL
     * provider, then creates a {@link DocumentCollectionManagerAsyncFactory} instance.
     *
     * @param       the type {@link DocumentCollectionManagerAsyncFactory}
     * @param settings the settings
     * @return a {@link DocumentCollectionManagerAsyncFactory}
     * @throws NullPointerException when settings is null
     * @see Settings
     * @see Settings {@link java.util.Map}
     */
     T get(Settings settings);

    /**
     * creates and returns a  {@link DocumentConfigurationAsync}  instance from {@link java.util.ServiceLoader}
     *
     * @param  the configuration type
     * @return {@link DocumentConfigurationAsync} instance
     * @throws jakarta.nosql.ProviderNotFoundException when the provider is not found
     * @throws jakarta.nosql.NonUniqueResultException  when there is more than one KeyValueConfiguration
     */
    static  T getConfiguration() {
        return (T) ServiceLoaderProvider.getUnique(DocumentConfigurationAsync.class);
    }

    /**
     * creates and returns a  {@link DocumentConfigurationAsync} instance from {@link java.util.ServiceLoader}
     * for a particular provider implementation.
     *
     * @param       the configuration type
     * @param supplier the particular provider
     * @return {@link DocumentConfigurationAsync} instance
     * @throws jakarta.nosql.ProviderNotFoundException when the provider is not found
     * @throws jakarta.nosql.NonUniqueResultException  when there is more than one KeyValueConfiguration
     */
    static  T getConfiguration(Class supplier) {
        return ServiceLoaderProvider.getUnique(DocumentConfigurationAsync.class, supplier);
    }
}