1 /*-
2 * #%L
3 * prolobjectlink-jpi
4 * %%
5 * Copyright (C) 2020 - 2021 Prolobjectlink Project
6 * %%
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 * #L%
25 */
26 package io.github.prolobjectlink.prolog.spi;
27
28 import io.github.prolobjectlink.prolog.Prolog;
29 import io.github.prolobjectlink.prolog.PrologProvider;
30
31 /**
32 * Bootstrap platform class. Contains {@link #getProvider(Class)} method that
33 * return an instance of Prolog Provider from the given class. Alternatively can
34 * be used {@link #getProvider()} for create and return a {@link PrologProvider}
35 * using Java Platform discovery pattern.
36 *
37 * @author Jose Zalacain
38 * @since 1.1
39 */
40 public final class ServiceProviderLocator {
41
42 /**
43 * Create and return an instance of Prolog Provider using Java Platform
44 * discovery pattern.
45 *
46 * @return an instance of Prolog Provider from the given class.
47 * @since 1.1
48 */
49 public static PrologProvider getProvider() {
50 return Prolog.getProvider();
51 }
52
53 /**
54 * Create and return an instance of Prolog Provider using the Prolog Provider
55 * class name.
56 *
57 * @return an instance of Prolog Provider from the given class.
58 * @since 1.1
59 */
60 public static PrologProvider getProvider(String className) {
61 return Prolog.getProvider(className);
62 }
63
64 /**
65 * Create and return an instance of Prolog Provider from the given class.
66 *
67 * @param providerClass Prolog Provider class used to create a new instance.
68 * @return an instance of Prolog Provider from the given class.
69 * @since 1.1
70 */
71 public static PrologProvider getProvider(Class<?> providerClass) {
72 return Prolog.getProvider(providerClass);
73 }
74
75 private ServiceProviderLocator() {
76 // DO NOTHING
77 }
78
79 }