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.function;
28
29 import gov.nist.secauto.metaschema.core.metapath.IExpression;
30
31 import java.util.List;
32 import java.util.stream.Stream;
33
34 import javax.xml.namespace.QName;
35
36 import edu.umd.cs.findbugs.annotations.NonNull;
37
38 public interface IFunctionLibrary {
39
40 /**
41 * Retrieve the collection of function signatures in this library as a stream.
42 *
43 * @return a stream of function signatures
44 */
45 @NonNull
46 Stream<IFunction> getFunctionsAsStream();
47
48 /**
49 * Determine if there is a function with the provided name that supports the
50 * signature of the provided methods.
51 *
52 * @param name
53 * the name of a group of functions
54 * @param arguments
55 * a list of argument expressions for use in determining an argument
56 * signature match
57 * @return {@code true} if a function signature matches or {@code false}
58 * otherwise
59 */
60 default boolean hasFunction(@NonNull String name, @NonNull List<IExpression> arguments) {
61 return getFunction(name, arguments) != null;
62 }
63
64 /**
65 * Determine if there is a function with the provided namespace qualified name
66 * that supports the signature of the provided methods.
67 *
68 * @param name
69 * the namespace qualified name of a group of functions
70 * @param arguments
71 * a list of argument expressions for use in determining an argument
72 * signature match
73 * @return {@code true} if a function signature matches or {@code false}
74 * otherwise
75 */
76 default boolean hasFunction(@NonNull QName name, @NonNull List<IExpression> arguments) {
77 return getFunction(name, arguments) != null;
78 }
79
80 /**
81 * Retrieve the function with the provided name that supports the signature of
82 * the provided methods, if such a function exists.
83 *
84 * @param name
85 * the name of a group of functions
86 * @param arguments
87 * a list of argument expressions for use in determining an argument
88 * signature match
89 * @return the matching function or {@code null} if no match exists
90 */
91 IFunction getFunction(@NonNull String name, @NonNull List<IExpression> arguments);
92
93 /**
94 * Retrieve the function with the provided namespace qualified name that
95 * supports the signature of the provided methods, if such a function exists.
96 *
97 * @param name
98 * the namespace qualified name of a group of functions
99 * @param arguments
100 * a list of argument expressions for use in determining an argument
101 * signature match
102 * @return the matching function or {@code null} if no match exists
103 */
104 IFunction getFunction(@NonNull QName name, @NonNull List<IExpression> arguments);
105 }