1 /*
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.metaschema.core.datatype;
28
29 import gov.nist.secauto.metaschema.core.datatype.adapter.MetaschemaDataTypeProvider;
30
31 import java.util.Collections;
32 import java.util.LinkedList;
33 import java.util.List;
34
35 import edu.umd.cs.findbugs.annotations.NonNull;
36
37 /**
38 * A base implementation of an {@link IDataTypeProvider}, supporting dynamic
39 * loading of Metaschema data type extensions at runtime.
40 * <p>
41 * The {@link MetaschemaDataTypeProvider} class provides an example of how to
42 * use this class to provide new data types.
43 */
44 public abstract class AbstractDataTypeProvider implements IDataTypeProvider {
45 private final List<IDataTypeAdapter<?>> library = new LinkedList<>();
46
47 @SuppressWarnings("null")
48 @Override
49 public List<? extends IDataTypeAdapter<?>> getJavaTypeAdapters() {
50 synchronized (this) {
51 return Collections.unmodifiableList(library);
52 }
53 }
54
55 /**
56 * Register the provided {@code adapter} with the type system.
57 *
58 * @param adapter
59 * the adapter to register
60 * @throws IllegalArgumentException
61 * if another type adapter has no name
62 */
63 protected void registerDatatype(@NonNull IDataTypeAdapter<?> adapter) {
64 if (adapter.getNames().size() == 0) {
65 throw new IllegalArgumentException("The adapter has no name: " + adapter.getClass().getName());
66 }
67 synchronized (this) {
68 library.add(adapter);
69 }
70 }
71 }