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.metapath;
28
29 import gov.nist.secauto.metaschema.core.metapath.item.node.IDocumentNodeItem;
30 import gov.nist.secauto.metaschema.core.model.IResourceLoader;
31 import gov.nist.secauto.metaschema.core.model.IUriResolver;
32 import gov.nist.secauto.metaschema.core.util.ObjectUtils;
33
34 import java.io.File;
35 import java.io.IOException;
36 import java.io.InputStream;
37 import java.net.URI;
38 import java.net.URISyntaxException;
39 import java.net.URL;
40 import java.nio.file.Files;
41 import java.nio.file.Path;
42
43 import edu.umd.cs.findbugs.annotations.NonNull;
44
45 public interface IDocumentLoader extends IResourceLoader {
46 void setUriResolver(@NonNull IUriResolver resolver);
47
48 @NonNull
49 default IDocumentNodeItem loadAsNodeItem(@NonNull File file) throws IOException {
50 return loadAsNodeItem(ObjectUtils.notNull(file.toPath()));
51 }
52
53 @NonNull
54 default IDocumentNodeItem loadAsNodeItem(@NonNull Path path) throws IOException {
55 try (InputStream is = ObjectUtils.notNull(Files.newInputStream(path))) {
56 return loadAsNodeItem(is, ObjectUtils.notNull(path.toUri()));
57 }
58 }
59
60 @NonNull
61 default IDocumentNodeItem loadAsNodeItem(@NonNull URL url) throws IOException, URISyntaxException {
62 return loadAsNodeItem(ObjectUtils.notNull(url.toURI()));
63 }
64
65 @NonNull
66 IDocumentNodeItem loadAsNodeItem(@NonNull URI uri) throws IOException;
67
68 @NonNull
69 IDocumentNodeItem loadAsNodeItem(@NonNull InputStream is, @NonNull URI documentUri) throws IOException;
70 }